From b94eaaa950223b6bae163aaf32123c3d7d4169a4 Mon Sep 17 00:00:00 2001 From: Justin Wernick Date: Wed, 7 Jun 2023 22:16:41 +0200 Subject: Add contributing documentation Fix #6 --- README.md | 17 +++++++++++------ 1 file changed, 11 insertions(+), 6 deletions(-) (limited to 'README.md') 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 -- cgit v1.2.3