Jingga/jsOMS
1
0
Fork 0
mirror of https://github.com/Karaka-Management/jsOMS.git synced 2026-01-24 15:38:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve coc and contribution guide

Browse Source
This commit is contained in:
Dennis Eichhorn 2018-02-06 20:03:25 +01:00
parent e92928aaad
commit ea94fafcdd
2 changed files with 27 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
.github/contributing.md vendored
View File

@ -1 +0,0 @@
A developer and contribution documentation can be found at https://orange-management.gitbooks.io/developer-guide/content/index.html.

27
CONTRIBUTING.md Normal file
View File

@ -0,0 +1,27 @@
# Contributing
## Code Style & Best Practices
For the code style and best practices please have a look at the developer-guide [https://github.com/Orange-Management/Developer-Guide](https://github.com/Orange-Management/Developer-Guide). Especially the `standards` should be followed for a successful pull request.
## How Can I Contribute
### Suggestions
If you have a good idea for improvement feel free to create a new issue with all the relevant information.
### Issues
Feel free to grab any open issue implement it and create a new pull request.
### Code Style
Not always are the defined coding style standards upheld, if you notice that simply create a new pull request with the fix.
### Code Coverage
While code coverage is just a metric it is still appreciated to cover as many files and code paths as possible. Just have a look at the code coverage and implement missing unit tests.
### Freatures
You have a good idea for a feature and can implement it yourself, go ahead and create a new pull request.