Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.4 KB

CONTRIBUTING.md

File metadata and controls

36 lines (22 loc) · 1.4 KB

How to contribute

If you value this software or depend on it for your product, consider sponsoring it and contributing to its codebase. Your support will help ensure the sustainability and growth of the project.

There are many ways to contribute:

  • Sponsor the project: Show your appreciation on GitHub or ko-fi.com
  • Find bugs and submit bug reports: Help making Htmldate an even more robust tool
  • Write code: Fix bugs or add new features by writing pull requests with a list of what you have done

A special thanks to the contributors who have played a part in Htmldate.

Testing and evaluating the code

Here is how you can run the tests and code quality checks. Pull requests will only be accepted if the changes are tested and if there are no errors.

  1. Install the necessary packages with pip install htmldate[dev]
  2. Run the tests and code quality tools:
    • Tests with pytest
    • Type checking with mypy on the directory: mypy htmldate/
    • Code formatting with black on the directory as well
    • Optional: install pre-commit to use the corresponding commit hooks

For further questions you can use GitHub issues or E-Mail.

Thanks,

Adrien