Merge pull request #1659 from pietervdvn/riQQ-patch-1

Editorial improvements in CONTRIBUTING docs
This commit is contained in:
Pieter Vander Vennet 2023-10-11 21:47:05 +00:00 committed by GitHub
commit bf940d9b1c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -6,22 +6,22 @@ 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/)
on [the Weblate 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
- A good start to contribute is to create a single map layer showing features which interest you. Read more about [making your own theme](/Docs/Making_Your_Own_Theme.md).
- 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 (except . This is
People who stick around and contribute in a meaningful way, _might_ be granted write access to the repository (except the branches *master* and *develop*). 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 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 GitHub. This means that this branch will be _automatically built_ and be **deployed**
to `https://pietervdvn.github.io/mc/<branchname>`. You can see the deploy process
on [Github Actions](https://github.com/pietervdvn/MapComplete/actions). Don't worry about pushing too much. These
deploys are free and totally automatic. They might fail if something is wrong, but this will hinder no-one.
on [GitHub Actions](https://github.com/pietervdvn/MapComplete/actions). Don't worry about pushing too much. These
deploys are free and totally automatic. They might fail if something is wrong, but this will hinder no one.
Additionaly, some other maintainer might step in and merge the latest develop with your branch, making later pull
requests easier.
@ -58,6 +58,6 @@ again to start fresh.
What not to contribute
----------------------
I'm currently _not_ accepting files for integration with some editor. There are hundreds of editors out there, if every single one of them needs a file in the repo, this ends up as a mess.
Furthermore, MapComplete doesn't want to encourage or discourage some editors.
I'm currently _not_ accepting files for integration with some text editor. There are hundreds of editors out there, if every single one of them needs a file in the repo, this ends up as a mess.
Furthermore, MapComplete doesn't want to encourage or discourage some text editors.
At last, these files are hard to maintain and are hard to detect if they have fallen out of use.