docs: updated contribution info

Author: adbar

CONTRIBUTING.md

@@ -15,14 +15,28 @@ There are many ways to contribute, you could:
   * Write tutorials or blog posts
   * Write code
 
+
 ## Submitting changes
 
 Please send a [GitHub Pull Request to trafilatura](https://github.com/adbar/trafilatura/pull/new/master) with a clear list of what you've done (read more about [pull requests](http://help.github.com/pull-requests/)).
 
 **Working on your first Pull Request?** See this tutorial: [How To Create a Pull Request on GitHub](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github)
 
-For further questions you can contact me by way of [GitHub issues](https://github.com/adbar/trafilatura/issues), [Twitter](https://twitter.com/adbarbaresi) or [E-Mail](http://adrien.barbaresi.eu/).
+
+
+## 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](tests/README.rst) for more information on the evaluation.
+
+
+
+For further questions you can contact me by way of [GitHub issues](https://github.com/adbar/trafilatura/issues), [Twitter](https://twitter.com/adbarbaresi) or [E-Mail](https://adrien.barbaresi.eu/).
 
 Thanks,
 
-Adrien
+Adrien

README.rst

@@ -132,7 +132,7 @@ Context
 Contributing
 ~~~~~~~~~~~~
 
-`Contributions <https://github.com/adbar/trafilatura/blob/master/CONTRIBUTING.md>`_ are welcome! Please also feel free to file issues on the `dedicated page <https://github.com/adbar/trafilatura/issues>`_.
+Contributions are welcome! See `CONTRIBUTING.md <https://github.com/adbar/trafilatura/blob/master/CONTRIBUTING.md>`_ for more information. Bug reports can be filed on the `dedicated page <https://github.com/adbar/trafilatura/issues>`_.
 
 Many thanks to the `contributors <https://github.com/adbar/trafilatura/graphs/contributors>`_ who submitted features and bugfixes!
 
@@ -171,8 +171,6 @@ This effort is part of methods to derive information from web documents in order
 
 You can contact me via my `contact page <https://adrien.barbaresi.eu/>`_ or `GitHub <https://github.com/adbar>`_.
 
-To have a chat about the software feel free to `book a 15 min slot <https://calendly.com/adbarba/15min>`_ for video-conferencing.
-
 
 Software
 ~~~~~~~~

docs/index.rst

@@ -145,6 +145,21 @@ Context
 These documentation pages also provides information on concepts behind data collection as well as practical tips on how to gather web texts (see `tutorials <tutorials.html>`_).
 
 
+
+Contributing
+~~~~~~~~~~~~
+
+Contributions are welcome! See `CONTRIBUTING.md <https://github.com/adbar/trafilatura/blob/master/CONTRIBUTING.md>`_ for more information. Bug reports can be filed on the `dedicated page <https://github.com/adbar/trafilatura/issues>`_.
+
+Many thanks to the `contributors <https://github.com/adbar/trafilatura/graphs/contributors>`_ who submitted features and bugfixes!
+
+
+Roadmap
+~~~~~~~
+
+For planned enhancements and relevant milestones see `issues page <https://github.com/adbar/trafilatura/milestones>`_.
+
+
 Author
 ~~~~~~
 
@@ -173,8 +188,6 @@ This effort is part of methods to derive information from web documents in order
 
 You can contact me via my `contact page <https://adrien.barbaresi.eu/>`_ or `GitHub <https://github.com/adbar>`_.
 
-To have a chat about the software feel free to `book a 15 min slot <https://calendly.com/adbarba/15min>`_ for video-conferencing.
-
 
 Software
 ~~~~~~~~