diff options
author | Justin Wernick <justin@worthe-it.co.za> | 2023-06-07 22:16:41 +0200 |
---|---|---|
committer | Justin Wernick <justin@worthe-it.co.za> | 2023-06-07 22:16:41 +0200 |
commit | b94eaaa950223b6bae163aaf32123c3d7d4169a4 (patch) | |
tree | d567a5c3c3bea520225530c25e2884d3147fdd38 | |
parent | 51bf45b4258dc85e6273c445d8e8bbf4688056ad (diff) |
Add contributing documentation
Fix #6
-rw-r--r-- | CONTRIBUTING.md | 41 | ||||
-rw-r--r-- | README.md | 17 |
2 files changed, 52 insertions, 6 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ca9515f --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing + +## Development Guide + +### Setting up a dev environment + +Install the following through your system's package manager or by visiting the +project's website. + +- [NodeJS](https://nodejs.org) 18 (LTS) or newer +- npm 8 or newer (note that this is generally bundled with Node + +### Building and running tests + +Dependencies are fetched with NPM. + +```sh +npm install +``` + +After fetching dependencies, tests can also be run using NPM. This includes both +linting and unit tests. + +```sh +npm test +``` + +## Submitting contributions + +If you have a change you'd like to contribute upstream, please open a pull +request on +[Codeberg](https://codeberg.org/worthe-it/south-african-id-parser/pulls). + +## I Have a Question + +If you have a question which isn't answered by any of the existing +documentation, please open an +[issue](https://codeberg.org/worthe-it/south-african-id-parser/issues). + +Please search the issues to see if anyone else has already asked the same +question before opening a new issue. @@ -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 |