CONTRIBUTING.md

Contribution Guidelines

Prerequisites

Finding an issue to work on

If you are looking for an issue to work on, you can check the issues page. If you find an issue you would like to work on, you can assign yourself to it by commenting on the issue and the maintainers will assign it to you. If you have an idea for a new feature, you can start by opening an issue and describe the feature you would like to implement, this will then be review by a maintainer and if approved you can begin your work and create a pull request.

Setup your environment locally

Some commands will assume you have the Github CLI installed, if you haven't, consider installing it, but you can always use the Web UI if you prefer that instead.

In order to contribute to this project, you will need to fork the repository:

gh repo fork LS6-Events/validjsonator

then, clone it to your local machine:

gh repo clone <your-github-name>/validjsonator

How to Contribute

Create a feature branch

git checkout -b <feat/fix/chore/docs>/<issue-number><short-description>

Implement your changes

When making commits, make sure to follow the conventional commit guidelines, i.e. prepending the message with feat:, fix:, chore:, docs:, etc... You can use git status to double check which files have not yet been staged for commit:

git add <file(s)> && git commit -m "feat/fix/chore/docs: commit message"

Push your changes

git push origin <branch-name>

Create a pull request

Once you have pushed your changes, you can create a pull request by running:

gh pr create --base main --head <branch-name>

NOTE: All pull requests should target the main branch.