From ea94fafcdde3d11496f3fb6624be6451d381ab4c Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Tue, 6 Feb 2018 20:03:25 +0100 Subject: [PATCH] Improve coc and contribution guide --- .github/contributing.md | 1 - CONTRIBUTING.md | 27 +++++++++++++++++++++++++++ 2 files changed, 27 insertions(+), 1 deletion(-) delete mode 100644 .github/contributing.md create mode 100644 CONTRIBUTING.md diff --git a/.github/contributing.md b/.github/contributing.md deleted file mode 100644 index 0dfdf24..0000000 --- a/.github/contributing.md +++ /dev/null @@ -1 +0,0 @@ -A developer and contribution documentation can be found at https://orange-management.gitbooks.io/developer-guide/content/index.html. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b0f7afa --- /dev/null +++ b/CONTRIBUTING.md @@ -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. \ No newline at end of file