Archive/rdio-scanner
1
0
Fork 0
mirror of https://github.com/chuot/rdio-scanner.git synced 2026-08-13 08:33:00 -06:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add CONTRIBUTING.md file

Browse source
This commit is contained in:
Chrystian Huot 2020-10-30 10:00:52 -04:00
parent 45edec5931
commit fc37ed2e09
2 changed files with 34 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
CONTRIBUTING.md Normal file
View file

@ -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.

1
README.md
View file

@ -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