From 6ee9ce91d34c9309c3623db5d5852c6336d108c8 Mon Sep 17 00:00:00 2001 From: Adrien Barbaresi Date: Mon, 30 Dec 2024 12:19:35 +0100 Subject: [PATCH] docs: update contributing guidelines (#125) * docs: update contributing guidelines * lint --- CONTRIBUTING.md | 35 ++++++++++++++++++++--------------- README.md | 35 ++++++++++++++--------------------- 2 files changed, 34 insertions(+), 36 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1590441b..c4a5f90d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,33 @@ ## How to contribute -Thank you for considering contributing to coURLan! -Here are some important resources: +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. - * [List of currently open issues](https://github.com/adbar/courlan/issues) (no pretention to exhaustivity!) - * [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/) +There are many ways to contribute: -There are many ways to contribute, you could: + * Sponsor the project: Show your appreciation [on GitHub](https://github.com/sponsors/adbar) or [ko-fi.com](https://ko-fi.com/adbarbaresi). + * Find bugs and submit bug reports: Help making Courlan an even more robust tool. + * Write code: Fix bugs or add new features by writing [pull requests](https://docs.github.com/en/pull-requests) with a list of what you have done. - * Improve the documentation - * Find bugs and submit bug reports - * Submit feature requests - * Write tutorials or blog posts - * Write code -## Submitting changes +A special thanks to the [contributors](https://github.com/adbar/courlan/graphs/contributors) who have played a part in Courlan. -Please send a [GitHub Pull Request to coURLan](https://github.com/adbar/courlan/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) +## Testing and evaluating the code -For further questions you can contact me by way of [GitHub issues](https://github.com/adbar/courlan/issues), [Twitter](https://twitter.com/adbarbaresi) or [E-Mail](https://adrien.barbaresi.eu/). +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. + +1. Install the necessary packages with `pip install courlan[dev]` +2. Run the tests and code quality tools: + - Tests with `pytest` + - Type checking with `mypy` on the directory: `mypy courlan/` + - Code formatting with `black` on the directory as well + + +For further questions you can use [GitHub issues](https://github.com/adbar/courlan/issues) or [E-Mail](https://adrien.barbaresi.eu/). Thanks, -Adrien \ No newline at end of file +Adrien diff --git a/README.md b/README.md index 2d64c5d6..2c6905cb 100644 --- a/README.md +++ b/README.md @@ -411,32 +411,25 @@ Details of strict URL filtering can be reviewed and changed in the file locally](https://packaging.python.org/tutorials/installing-packages/#installing-from-a-local-src-tree). -## Contributing - -[Contributions](https://github.com/adbar/courlan/blob/master/CONTRIBUTING.md) -are welcome! - -Feel free to file issues on the [dedicated -page](https://github.com/adbar/courlan/issues). - - ## Author -Developed with practical applications of academic research in mind, this software -is part of a broader effort to derive information from web documents. -Extracting and pre-processing web texts to the exacting standards of -scientific research presents a substantial challenge. -This software package simplifies text data collection and enhances corpus quality, -it is currently used to build [text databases for research](https://www.dwds.de/d/k-web). +Initially launched to create text databases for research purposes +at the Berlin-Brandenburg Academy of Sciences (DWDS and ZDL units), +this package continues to be maintained but its future development +depends on community support. -- Barbaresi, A. "[Trafilatura: A Web Scraping Library and - Command-Line Tool for Text Discovery and - Extraction](https://aclanthology.org/2021.acl-demo.15/)." - *Proceedings of ACL/IJCNLP 2021: System Demonstrations*, 2021, pp. 122-131. +**If you value this software or depend on it for your product, consider +sponsoring it and contributing to its codebase**. Your support +[on GitHub](https://github.com/sponsors/adbar) or [ko-fi.com](https://ko-fi.com/adbarbaresi) +will help maintain and enhance this package. +Visit the [Contributing page](https://github.com/adbar/courlan/blob/master/CONTRIBUTING.md) +for more information. -Contact: see [homepage](https://adrien.barbaresi.eu/). +Reach out via the software repository or the [contact +page](https://adrien.barbaresi.eu/) for inquiries, collaborations, or +feedback. -Software ecosystem: see [this +For more on Courlan's' software ecosystem see [this graphic](https://github.com/adbar/trafilatura/blob/master/docs/software-ecosystem.png).