Thank you for wanting to contribute to the AnnotatedJS project!
The full test suite can be ran via the npm test command. It also runs as part of the PR pipeline.
Please send a GitHub Pull Request to AnnotatedJS with a clear list of what you've done (read more about pull requests).
Always write a clear log message for your commits. One-line messages are fine for small changes, but bigger changes should look like this:
$ git commit -m "A brief summary of the commit
>
> A paragraph describing what changed and its impact."
AnnotatedJS uses the default prettier formatter. The command npm run format will automatically format the codebase.
Please bump the version number of the package based on the type of PR (Feature or Fix). Also be sure that the package-lock.json is updated as well!
AnnotatedJS follows TSDoc standards and utilizes TypeDoc. The documentation can be generated using the npm run docs command. The docs will be generated in the pipeline when merging to master.
Please be sure to update or add any necessary documentation when making changes.