-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
30 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Contributing to the ZARN! | ||
|
||
## Branches | ||
|
||
The `main` branch is used only for holding released code of the project. Any | ||
new feature or bugfix **must** be opened against `develop` branch, where some | ||
additional testing is performed before the code lands `main`. | ||
|
||
## Testing | ||
|
||
For every new feature, please, submit in the same PR a testing code (under | ||
`t/` folder) to cover that completely. Make sure to expand and cover the | ||
added/replaced code as much as possible. | ||
|
||
In case it's a functional bugfix (not a typo, commentary, whitespace, ... | ||
issue), make sure to check why the test code didn't trigger the bug before | ||
and, if possible, update the test. | ||
|
||
## Great Re-Writings | ||
|
||
Open a discussion issue before you begin. So we can listen to what you have to | ||
say, and we can provide a referral if it will be worth changing big parts of | ||
the project. | ||
|
||
## License | ||
|
||
By opening a pull request in this repository, you agree to provide your work | ||
under the [project license](../LICENSE.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters