Skip to content

Latest commit

 

History

History
42 lines (25 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

42 lines (25 loc) · 1.58 KB
Raw

How to contribute to h8mail

First of all, thank you for considering contributing 💜
h8mail is very much a script turned into a tool. As such, the project is still evolving in regards to contribution guidelines.

If this is your first contribution, I highly suggest you check this repo first.

The basics

  • h8mail should only depend on the requests package

  • If adding a new feature or refactoring, consider opening an issue or sending me an email beforehand to ensure things go smoothly

  • Comment your functions as docstrings

  • Pull requests should be merged into the latest development branch, not in the main branch

    • If there is no on-going development branch, there should still be the current version's dev branch
    • If unsure, open an issue and you'll be pointed to the right branch, or a seperate branch can be created for you

  • Make sure your code passes the included tests. You can run them by using python3 -m unittest in h8mail's top level directory

  • Code should be formatted using Python Black. Most IDE's can run black directly. You can also launch it from CLI

Ways to contribute

  • Bug reports using issues
  • Bug fixes (please open issues for typos)
  • Code refactoring (please open issue beforehand if > 2 lines)
  • Code optimisation
  • New features
  • New API integrations

Code of conduct

h8mail follows Django's code of conduct.