summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthäus G. Chajdas <dev@anteru.net>2022-02-27 16:21:55 +0100
committerMatthäus G. Chajdas <dev@anteru.net>2022-02-27 16:21:55 +0100
commit8d2e31d1966f42808595bccc3384062c2942fc74 (patch)
treefa0032d3dff53afb46ff976987470c4df5e255a4
parent122ad379c2c5c6a5b85b095edb8c80c28c4c3c60 (diff)
downloadpygments-git-8d2e31d1966f42808595bccc3384062c2942fc74.tar.gz
Update contributing guidelines.
-rw-r--r--Contributing.md5
1 files changed, 4 insertions, 1 deletions
diff --git a/Contributing.md b/Contributing.md
index 0856690f..ac17dd68 100644
--- a/Contributing.md
+++ b/Contributing.md
@@ -26,6 +26,9 @@ Contribution checklist
[a new formatter](https://pygments.org/docs/formatterdevelopment/) or
[a new filter](https://pygments.org/docs/filterdevelopment/)
+* Make sure to add a test for your new functionality, and where applicable,
+ write documentation.
+
* When writing rules, try to merge simple rules. For instance, combine:
```python
@@ -46,7 +49,7 @@ Contribution checklist
```
* Be careful with ``.*``. This matches greedily as much as it can. For instance,
- rule like ``@.*@`` will match the whole string ``@first@ second @third@``,
+ a rule like ``@.*@`` will match the whole string ``@first@ second @third@``,
instead of matching ``@first@`` and ``@second@``. You can use ``@.*?@`` in
this case to stop early. The ``?`` tries to match _as few times_ as possible.