1berry/Amulet-Map-Editor
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Cleaned up contributing and added a language section

Browse Source 
Moved the old contributing into contributing/dev.md and updated.
Added contributing/lang.md
Updated contributing.md to link to the new docs
This commit is contained in:
gentlegiantJGC 2021-03-31 12:45:54 +01:00
parent 93e16d95f8
commit 6e35931923
3 changed files with 61 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
contributing.md
View File

@ -1,29 +1,8 @@
## Contributing
### Branch Naming
Branches should be created when a certain bug or feature may take multiple attempts to fix. Naming
them should follow the following convention (even for forked repositories when a pull request is being made):
If you wish to report a bug in the program or suggest a feature please first [search the existing bugs and features](https://github.com/Amulet-Team/Amulet-Map-Editor/issues) to see if it already exists.
If not [create a new issue](https://github.com/Amulet-Team/Amulet-Map-Editor/issues/new/choose).
* For features, use: `impl-<feature name>`
* For bug fixes, use: `bug-<bug tracker ID>`
* For improvements/rewrites, use: `improv-<feature name>`
* For prototyping, use: `proto-<feature name>`
If you wish to contribute translations to the project see [the translation guidelines](contributing/lang.md)
### Code Formatting
For code formatting, we use the formatting utility [black](https://github.com/ambv/black). To run
it on a file, run the following command from your favorite terminal after installing: `black <path to file>`
While formatting is not strictly required for each commit, we ask that after you've finished your
code changes for your Pull Request to run it on every changed file.
### Pull Requests
We ask that submitted Pull Requests give moderately detailed notes about the changes and explain
any changes that were made to the program outside of those directly related to the feature/bug-fix.
Please make sure to run all tests and include a written verification that all tests have passed.
_Note: We will also re-run all tests before reviewing, this is to mitigate additional changes/commits
needed to pass all tests._
Once a Pull Request is submitted, we will mark the request for review, once that is done, we will
review the changes and provide any notes/things to change. Once all additional changes have been made,
we will merge the request.
If you wish to contribute code to the project see [the developer guidelines](contributing/dev.md)

38
contributing/dev.md Normal file
View File

@ -0,0 +1,38 @@
## Developer Contributing
This is intended for developers wishing to contribute code to the project.
### Branch Naming
A branch must be created in order to contribute code to the project.
Unless you have permissions to create branches in Amulet-Team you will first need to [fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo).
You must then create a branch with an identifiable name using the following convention:
* For features, use: `impl-<feature name>`
* For bug fixes, use: `bug-<bug tracker ID>`
* For improvements/rewrites, use: `improv-<feature name>`
* For prototyping, use: `proto-<feature name>`
### Tests
There are a number of tests to make sure that the code behaves correctly.
If you are making changes to the code these should be run before creating the pull request.
### Code Formatting
For code formatting, we use the formatting utility [black](https://github.com/ambv/black).
To run it on a file, run the following command from your favorite terminal after installing: `black <path to file>`
While formatting is not strictly required for each commit, we ask that after you've finished your
code changes for your Pull Request to run it on every changed file.
The following command will run it on all files. `black .`
### Pull Requests
Once you have added the desired changes and run tests and formatting you will need to [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
We ask that submitted Pull Requests give moderately detailed notes about the changes and explain
any changes that were made to the program outside of those directly related to the feature/bug-fix.
Once a Pull Request is submitted, we will mark the request for review.
Once that is done, we will review the changes and may provide feedback on things to change.
Once all additional changes have been made, we will merge the request.
The tests and code formatting will be run automatically when the pull request is created to verify that everything is okay.
This can be seen at the bottom of the pull request page.

19
contributing/lang.md Normal file
View File

@ -0,0 +1,19 @@
## Language Contributing
This is intended for anyone wishing to contribute translations to the project.
### Branch Naming
A branch must be created in order to contribute to the project.
Unless you have permissions to create branches in Amulet-Team you will first need to [fork the repository](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo).
You must then create a branch with an identifiable name using the following convention:
* When adding languages, use: `impl-lang-<langauge code>`
* When fixing languages, use: `improv-lang-<langauge code>`
### Pull Requests
Once you have added the desired changes you will need to [create a pull request](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
We ask that submitted Pull Requests give moderately detailed notes about the changes.
Once a Pull Request is submitted, we will mark the request for review.
Once that is done, we will review the changes and may provide feedback on things to change.
Once all additional changes have been made, we will merge the request.