From 461e8ccffec1f2e8eab87ca3b4c8dcda6ff38424 Mon Sep 17 00:00:00 2001 From: pietervdvn Date: Wed, 12 Jan 2022 00:31:42 +0100 Subject: [PATCH] Add contributing.md based on previous documentation --- Docs/ContributorRights.md => CONTRIBUTING.md | 25 ++++++++++++++------ 1 file changed, 18 insertions(+), 7 deletions(-) rename Docs/ContributorRights.md => CONTRIBUTING.md (60%) diff --git a/Docs/ContributorRights.md b/CONTRIBUTING.md similarity index 60% rename from Docs/ContributorRights.md rename to CONTRIBUTING.md index c9257350d..783dfbe5e 100644 --- a/Docs/ContributorRights.md +++ b/CONTRIBUTING.md @@ -1,9 +1,20 @@ +Contributing to MapComplete +=========================== + +Hi! Thanks for checking out how to contribute to MapComplete! + +There are multiple ways to contribute: + +- Translating MapComplete to your own language can be done on [this website](https://hosted.weblate.org/projects/mapcomplete/) +- If you encounter a bug, the [issue tracker](https://github.com/pietervdvn/MapComplete/issues) is the place to be +- If you want to improve a theme, create a new theme, spot a typo in the repo... the best way is to open a pull request. + +People who stick around and contribute in a meaningful way, _might_ be granted write access to the repository. This is done on a purely subjective basis, e.g. after a few pull requests and if you are a member of the OSM community. + Rights of contributors -====================== +----------------------- -If a contributor is quite active within MapComplete, this contributor might be granted access to the main repository. - -If you have access to the repository, you can make a fork of an already existing branch and push this new branch to +If you have write access to the repository, you can make a fork of an already existing branch and push this new branch to github. This means that this branch will be _automatically built_ and be **deployed** to `https://pietervdvn.github.io/mc/`. You can see the deploy process on [Github Actions](https://github.com/pietervdvn/MapComplete/actions). Don't worry about pushing too much. These @@ -19,8 +30,8 @@ As a non-admin contributor, you can _not_ make changes to the `master` nor to th soon as master is changed, this is built and deployed on `mapcomplete.osm.be`, which a lot of people use. An error there will cause a lot of grieve. -A push on `develop` is automatically deployed to [pietervdvn.github.io/mc/develop] and is used by quite some people to. -People using this version should know that this is a testing ground for new features and might contain a bug every now +A push on `develop` is automatically deployed to [pietervdvn.github.io/mc/develop] which is used by quite some contributors. +However, people using this version should know that this is a testing ground for new features and might contain a bug every now and then. In other words, to get your theme deployed on the main instances, you'll still have to create a pull request. The @@ -39,4 +50,4 @@ To do this: push to your fork. Alternatively, if you don't have any unmerged changes, you can remove your local copy and clone `pietervdvn/MapComplete` -again to start fresh. \ No newline at end of file +again to start fresh.