Thank you for considering contributing to Bamp. You are very welcomed to help fixing bugs, merging pull requests, writing docs, suggesting improvements or filing bug reports.
Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests.
If you never contributed to open source please have a look at these free tutorials:
- Create your own fork of the code
- Do the changes in your fork
- If you like the change and think the project could use it:
- Be sure you have followed the code style for the project.
- Write unit tests, and if required interface tests
- Check your code against pycodestyle and/or pylint
Please raise issues on github, but first search if the issue hasn't been raised yet. When filing an issue, make sure to answer these five questions:
- What version of Python are you using (go version)?
- What operating system are you using?
- What did you do?
- What did you expect to see?
- What did you see instead?
Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
You won't be surprised if I write here that PEP8 is followed in this project. I already mentioned earlier that it would be useful to run pycodestyle against your code.
Short summary of changes (50 chars or less). If it's necessary please include more detailed explanation. Keep the length line around 72 chars.