Skip to content
Permalink
Browse files

docs: add new rules about target branch for code contributions

  • Loading branch information
Deuchnord committed Feb 3, 2020
1 parent 1dffd79 commit f923eb92db785354fc29299d43e0744ff7d9d207
Showing with 11 additions and 0 deletions.
  1. +11 −0 CONTRIBUTING.md
@@ -24,8 +24,19 @@ If you speak another language than English, another nice way to enhance Kosmorro
First of all, if you are fixing an opened issue, check that nobody is already working on it — if someone seems to be but their Pull Request seems stuck, please ask them first if you can continue the development. If you retake the code they produced, **don't change the author of the commits**.

Before writing the code, first create a fork of the repository and clone it. You may also want to add the original repository (`Deuchnord/kosmorro`), so you can update your fork with the last upstream commits.

Then create a new branch and start coding. Finally, commit and push, then open a PR on this project. If your project is not complete, feel free to open it as Draft (if you forgot to activate the Draft status, just edit the first comment to say it), then mark it as ready for review when you're done.

### Choosing the right target branch

Whatever you are doing, always base your working branch on `master`.
When you create your PR, please consider selecting the right target branch:

- If you are fixing a bug or optimizing something, then target the `master` branch.
- If you are doing anything else, then target the `feature` branch.

This allows to make easier to publish patch releases, which have a higher priority than the minor releases.

### Dealing with the translations

The messages file contains all the messages Kosmorro can display, in order to make them translatable. When you change code, you may change also the messages displayed by the software.

0 comments on commit f923eb9

Please sign in to comment.
You can’t perform that action at this time.