From 7c25a7dc2fff0637a40c49a099bec37886d443aa Mon Sep 17 00:00:00 2001 From: Szymon Date: Sun, 16 Jun 2024 12:49:02 +0200 Subject: [PATCH] updated contribution guidelines --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 900aab0..7d23a33 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -34,7 +34,7 @@ The package lives as long as contributors are willing to maintain it, so we are ### Developing new features **Caution!** If you are not willing to write tests and docstrings for a feature, it will not be accepted by the maintainers. - Ideally, ask first if you want to introduce a new feature. Then, you will get additional guidance from the package maintainers, and you will not produce something that might burden other maintainers in the future. -- Every new feature must be well-documented. See [Documenting Features] section in the Developer's Guide. +- Every new feature must be well-documented. See [Docstrings](docs/dev-docstrings.md) section in the Developer's Guide. - Every new feature must have at least one unit or functional test written. See [Writing Tests] section in the Developer's Guide. - Features derived from scientific literature must be cited in a docstring's `Bibliography` section. See [Citing Others] section in the Developer's Guide. - *Optional* - write a tutorial about the new feature in a notebook.