diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0b5fe06..97f53be 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,9 +4,11 @@ Thanks for wanting to contribute to the project! There are many things we appreciate help with. The simplest is to report problems you see in the documentation or while using the project, by creating an issue. -If you have a specific change you'd like to submit, be it documentation, bug fixes or new features, please read our guide on [how to create merge requests following our conventions](https://gitlab.com/opensavvy/wiki/-/blob/main/README.md#wiki). +If you have a specific change you'd like to submit, be it documentation, bug fixes or new features, please read our [contribution guide](https://opensavvy.dev/open-source/index.html#contributing-to-open-source-projects). > Before starting making large changes, please do talk about it with us! Some things, in particular, deploying to new platforms requires changes on our side as well. +> +> The simplest way of contacting us is by creating an issue on this repository, or commenting in an existing issue. Some projects may also have a Discord server, if you prefer reaching us there. ## Issue tracking diff --git a/README.md b/README.md index cde119c..614bf48 100644 --- a/README.md +++ b/README.md @@ -14,5 +14,5 @@ This a template to easily bootstrap your projects. ## Contributing See [CONTRIBUTING.md](CONTRIBUTING.md). -- To learn more about our coding conventions and workflow, see the [OpenSavvy Wiki](https://gitlab.com/opensavvy/wiki/-/blob/main/README.md#wiki). +- To learn more about our coding conventions and workflow, see the [OpenSavvy website](https://opensavvy.dev/open-source/index.html). - This project is based on the [OpenSavvy Playground](docs/playground/README.md), a collection of preconfigured project templates. -- 2.51.2 From 69ffbf4c93de42388964c2d343c9621cb0d9ef4e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ivan=20=E2=80=9CCLOVIS=E2=80=9D=20Canet?= Date: Mon, 30 Sep 2024 23:05:32 +0200 Subject: [PATCH 2/2] docs: Mention GitPod & DevContainer --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 614bf48..01cc8c4 100644 --- a/README.md +++ b/README.md @@ -16,3 +16,5 @@ This a template to easily bootstrap your projects. See [CONTRIBUTING.md](CONTRIBUTING.md). - To learn more about our coding conventions and workflow, see the [OpenSavvy website](https://opensavvy.dev/open-source/index.html). - This project is based on the [OpenSavvy Playground](docs/playground/README.md), a collection of preconfigured project templates. + +If you don't want to clone this project on your machine, it is also available using [GitPod](https://www.gitpod.io/) and [DevContainer](https://containers.dev/) ([VS Code](https://code.visualstudio.com/docs/devcontainers/containers) • [IntelliJ & JetBrains IDEs](https://www.jetbrains.com/help/idea/connect-to-devcontainer.html)). Don't hesitate to create issues if you have problems getting the project up and running.