CONTRIBUTING.md

How to contribute

Thank you for considering contributing to trafilatura!

Here are some important resources:

• List of currently open issues (no pretention to exhaustivity!)
• How to Contribute to Open Source

There are many ways to contribute, you could:

• Improve the documentation
• Find bugs and submit bug reports
• Submit feature requests
• Write tutorials or blog posts
• Write code

Submitting changes

Please send a GitHub Pull Request to trafilatura with a clear list of what you've done (read more about pull requests).

Working on your first Pull Request? See this tutorial: How To Create a Pull Request on GitHub

Testing and evaluating the code

Here is how you can run the tests if you wish to correct the errors and further improve the code:

• 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
• Check how it performs on the benchmark in tests/eval/ by running tests/comparison.py

See also the tests Readme for more information on the evaluation.

For further questions you can contact me by way of GitHub issues, Twitter or E-Mail.

Thanks,

Adrien