Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (25 loc) · 2.12 KB

CONTRIBUTING.md

File metadata and controls

43 lines (25 loc) · 2.12 KB
Raw

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 Trafilatura 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.
  • Improve the documentation: Write tutorials and guides, correct mistakes, or translate existing content.
  • Submit feature requests: Share your feedback and suggestions.

Here are some important resources:

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

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 they there are no errors.

  • Install the necessary packages with pip install trafilatura[dev]
  • Run pytest from trafilatura's directory, or select a particular test suite, for example realworld_tests.py, and run pytest realworld_tests.py or simply python3 realworld_tests.py
  • Run mypy on the directory: mypy trafilatura/
  • Lint and format the code with ruff: ruff check . + ruff format trafilatura tests

If you work on text extraction it is useful to check if performance is equal or better on the benchmark.

See the tests Readme and the testing page in the documentation for more information.

For further questions you can use GitHub issues and discussion pages, or E-Mail.

Thanks,

Adrien