Skip to content

Latest commit

 

History

History
17 lines (13 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

17 lines (13 loc) · 1.4 KB
Raw

Thank you for using archetypal and for considering contributing to it!

For errors in the code:

  • read the error message and documentation;
  • search through the open issues and closed issues first;
  • if the problem is with a dependency of this project, open an issue on the dependency's repo;
  • if the problem is with archetypal and you can fix it simply, please submit a PR;
  • if the problem persists, please open an issue in the issue tracker including a minimal working example to reproduce the problem.

If you have a feature proposal or want to contribute

  • post your proposal on the issue tracker so we can review it together (some proposals may not be a good fit for the project);
  • fork the repo, make your change (adhering to archetypal's existing coding format, commenting, and docstring styles); test it;
  • format your code using black and submit a PR;
  • respond to code review.