If you're reading this, you're probably interested in contributing to Songbee. Thank you very much! Open source projects live-and-die based on the support they receive from others, and the fact that you're even considering contributing to our project is very generous of you.
Songbee is a community-driven project. As such, we welcome and encourage all sorts of contributions. They include, but are not limited to:
- Constructive feedback
- Questions about usage
- Bug reports / technical issues
- Documentation changes
- Feature requests
- Pull requests
We strongly suggest that before filing an issue, you search through the existing issues to see if it has already been filed by someone else.
If you are opening an issue about a bug, make sure that you include clear steps for how we can reproduce the problem. If we can't reproduce it, we can't fix it. If you are suggesting a feature, make sure your explanation is clear and detailed.
For now there isn't much routine for you to do. Sometime we'll have tests, docs, a changelog and lots of other fancy neat stuff. For now there are just a few things to keep in mind:
- Coding style:
[[BRIEF CODING STYLE DESCRIPTION HERE]]“In lieu of a formal style guide, take care to maintain the existing coding style.” - License: (see below)
This project is unlicensed. If you want to contribute, you have to sign the Copyright wavier. Fortunately, it's a matter of seconds as we use the CLA assistant — it will provide instructions on your first pull request.
Here's what you'll be signing:
for Songbee projects (https://github.com/Songbee)
I dedicate any and all copyright interest in this software to the public domain. I make this dedication for the benefit of the public at large and to the detriment of my heirs and successors. I intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.
To the best of my knowledge and belief, my contributions are either originally authored by me or are derived from prior works which I have verified are also in the public domain and are not subject to claims of copyright by other parties.
To the best of my knowledge and belief, no individual, business, organization, government, or other entity has any copyright interest in my contributions, and I affirm that I will not make contributions that are otherwise encumbered.