Skip to content

Latest commit

 

History

History
46 lines (33 loc) · 1.38 KB

CONTRIBUTING.md

File metadata and controls

46 lines (33 loc) · 1.38 KB

Contributing to DEAP-er

We love your input! You can contribute to this project by:

  • Reporting bugs
  • Contributing source code
  • Discussing the current state of the code
  • Proposing new features
  • Becoming a maintainer

Reporting Bugs

We use GitHub issues to track bugs. Report a bug by opening a new issue.

Great Bug Reports tend to have:

  • A quick summary and/or background.
  • Specific description of steps to reproduce.
  • What you expected would happen.
  • What actually happens.
  • Sample code.
  • Notes, observations or theories.

Help us fix bugs faster by issuing Great Bug Reports.

Contributing Code

Use the Github Flow to propose code changes to the project:

  1. Fork the repo and create your branch from master.
  2. If you've changed APIs, update the documentation.
  3. If you've added code, add tests for that code.
  4. Ensure all the tests pass.
  5. Make sure your code passes linting.
  6. Issue that pull request!

Coding Style

  • Code must be formatted with the black formatter.
  • Indent with tabs, not spaces.
  • Use code logic separators such as:
    • # =========== #
    • # ------------------- #

License

By contributing, you agree that your contributions will be licensed under the MIT License.