If you discover issues, have ideas for improvements or new features, please report them to the issue tracker of the repository or submit a pull request. Please, try to follow these guidelines when you do so.
- Check that the issue has not already been reported.
- Check that the issue has not already been fixed in the latest code
(a.k.a.
master). - Be clear, concise and precise in your description of the problem.
- Open an issue with a descriptive title and a summary in grammatically correct, complete sentences.
- Mention your
garmdownPython dependency version and operating system. - Include any relevant code to the issue summary.
Adding information like the backtrace and the REPL messages to the bug report makes it easier to track down bugs. Some steps to reproduce a bug reliably would also make a huge difference.
- Read how to properly contribute to open source projects on Github.
- Use a topic branch to easily amend a pull request later, if necessary.
- Use the same coding conventions as the rest of the project.
- Make sure that the unit tests are passing (
make test). - Write good commit messages.
- Mention related tickets in the commit messages (e.g.
[Fix #N] Add command ...). - Update the changelog.
- Squash related commits together.
- Open a pull request that relates to only one subject with a clear title and description in grammatically correct, complete sentences.