Updated contributing section of README.md

This commit is contained in:
amevarashi 2024-06-13 20:37:53 +05:00
parent 861c753e22
commit ebb9708efe

View file

@ -39,6 +39,14 @@ The only consistent way to get in touch with me is the RJW Discord server #sexpe
Please, ping me in the RJW Discord if you rased the issue here.
### Contributing
All work should be done based of the `dev` branch! Trying to compile on the `master` branch will fail - this is intentional. While I can't do something like that for XML and translations, I may choose to reject the pull request based on the amount of work required to transfer all commits into the `dev` branch.
The best practices:
1. Fork this repository.
2. In your fork create a new branch based on `dev`. The name of the new branch should reflect what you are changing in 3 words or less, separated by `-`. For example `rmb-menu-refactor` or `japanese-translation`.
3. Make your changes and commit them to the new branch.
4. Create a new merge request from your branch into the `dev` branch of this repository.
To be consistent with RJW, please use TABS not SPACES.
Please, ping me in the RJW Discord after creating a merge request.