Contributing

Bug fixes, feature additions, tests, documentation and more can be contributed via issues and/or pull requests. All contributions are welcome.

Bug fixes, feature additions, etc.

Please send a pull request to the master branch. Please include documentation and tests for new or changed features. Tests or documentation without bug fixes or feature additions are welcome too.

  • Fork the DefTree repository.
  • Create a branch from master.
  • Develop bug fixes, features, tests, etc.
  • Run the test suite.
  • Create a pull request to pull the changes from your branch to the DefTree master.

Guidelines

  • Separate code commits from reformatting commits.
  • Provide tests for any newly added code.
  • Follow PEP8.

Reporting Issues

When reporting issues, please include code that will reproduce the issue. The best reproductions are self-contained scripts with minimal dependencies.