summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJustin Wernick <justin@worthe-it.co.za>2023-06-07 22:16:41 +0200
committerJustin Wernick <justin@worthe-it.co.za>2023-06-07 22:16:41 +0200
commitb94eaaa950223b6bae163aaf32123c3d7d4169a4 (patch)
treed567a5c3c3bea520225530c25e2884d3147fdd38 /README.md
parent51bf45b4258dc85e6273c445d8e8bbf4688056ad (diff)
Add contributing documentation
Fix #6
Diffstat (limited to 'README.md')
-rw-r--r--README.md17
1 files changed, 11 insertions, 6 deletions
diff --git a/README.md b/README.md
index e359a22..9751463 100644
--- a/README.md
+++ b/README.md
@@ -140,6 +140,14 @@ var isSouthAfricanCitizen = saIdParser.parseIsSouthAfricanCitizen(validIdNumber)
// isSouthAfricanCitizen === true
```
+## Releases
+
+See [CHANGELOG.md](./CHANGELOG.md) for release notes.
+
+Releases are also available on
+[NPM](https://www.npmjs.com/package/south-african-id-parser) and
+[Codeberg](https://codeberg.org/worthe-it/south-african-id-parser/releases).
+
## Reporting issues
Please report any issues on the project's [issue
@@ -153,13 +161,10 @@ features.
This project is still actively maintained. Reported issues will be addressed,
and dependencies will be kept up to date.
-## Releases
-
-See [CHANGELOG.md](./CHANGELOG.md) for release notes.
+## Contributing
-Releases are also available on
-[NPM](https://www.npmjs.com/package/south-african-id-parser) and
-[Codeberg](https://codeberg.org/worthe-it/south-african-id-parser/releases).
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on setting up a
+development environment to make changes and submit contributions.
## Support