All contributions are welcome and greatly appreciated. Every little bit helps, and credit will always be given.
When reporting a bug please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
config-man could always use more documentation, whether as part of the official config-man docs or even on the web in blog posts, articles, and such.
The best way to send feedback is to file an issue here.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that code contributions are welcome :)
To set up config-man for local development:
- Fork config-man
- Clone your fork locally
- Create a branch for local development
- Apply changes
- Add yourself to
AUTHORS.md - Commit your changes and push your branch to GitHub
- Submit a pull request through the GitHub website.
If you need some code review or feedback while you're developing the code just make the pull request. Also please follow the following guidelines:
- Use PEP 8 code style
- 120 characters line limit
- double quotes are preferred
- don't forget newline at the end of the file
- Commit messages should be self explanatory. It should answer following questions:
- Why is this change necessary?
- How does it address the issue?
- What side effects does this change have?
- Your branch should have just the right number of commits not too many, not too few.
- Logically relevant changes SHOULD get committed together.
- Logically irrelevant changes SHOULD NOT get committed together.