diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..f9a92eb --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,33 @@ +# Guide lines for contributing to [Rdio Scanner](https://github.com/chuot/rdio-scanner) + +Please follow these simple guidelines to contribute to [Rdio Scanner](https://github.com/chuot/rdio-scanner). Discuss the change first through [GitHub Issues](https://github.com/chuot/rdio-scanner/issues), email, or any other method with the [owner and project manager](https://github.com/chuot). + +## Support requests or general question + +Any support request or general question is welcome in the [Gitter Rdio Scanner Lobby](https://gitter.im/rdio-scanner/Lobby). Do not create an issue for this, it will be rejected and closed immediately. + +Helping others on the (https://github.com/chuot/rdio-scanner/wiki) is a good way for contributing to the project. + +## Wiki pages + +Any contribution to the [Rdio Scanner Wiki](https://github.com/chuot/rdio-scanner/wiki) is welcome and encouraged. It is impossible for the [owner and project manager](https://github.com/chuot) to cover all the [Rdio Scanner](https://github.com/chuot/rdio-scanner) use cases, sharing your own use cases with guided instructions will for sure benefit others. + +Any contribution to the [Rdio Scanner Wiki](https://github.com/chuot/rdio-scanner/wiki) is welcome and encouraged. + +It is also not possible for the [owner and project manager](https://github.com/chuot) to cover all the [Rdio Scanner](https://github.com/chuot/rdio-scanner) use cases, sharing your own use cases with guided instructions is sure to benefit others. + +## Random Pull Requests + +To keep the project stable and well organized, random pull requests will be rejected if no issue have been previously opened and assigned first by the [owner and project manager](https://github.com/chuot). + +## Bugs and feature requests + +We use [GitHub Issues](https://github.com/chuot/rdio-scanner/issues) to track bugs and feature requests. + +Open an [issue](https://github.com/chuot/rdio-scanner/issues) that best describes the bug or feature request. + +For **bugs**, describe the environment in which you encounter it and explain step by step how to reproduce them. + +For **feature requests**, describe the reason and use case. + +Most of the time, the issue will be assigned to the [owner and project manager](https://github.com/chuot) and then resolved in a timely manner. In some cases, the issue will be identified as _help needed_ and then assigned to a volonteer contributor. Again, pull requests will be rejected if they are not related to a previously opened and assigned issue. diff --git a/README.md b/README.md index 772b310..c31bce9 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,7 @@ The server side of [Rdio Scanner](https://github.com/chuot/rdio-scanner) can mon - [docs/webapp.md](./docs/webapp.md) - How to operate the frontend interface - [docs/api.md](./docs/api.md) - [Rdio Scanner](https://github.com/chuot/rdio-scanner) API's reference - [docs/examples](./docs/examples) - Some miscellaneous examples +- [CONTRIBUTING.md](./CONTRIBUTING.md) - Contribution guidelines ## Questions / Comments