CONTRIBUTING.md

Contributing to djs-marshal

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

The 'main' branch is dev, not master. Keep in mind when cloning the repo and submitting a PR

Using git flow

I use the git flow workflow for this repository. I recommend you to do the same. You can read about it here

Commit message format

We follow a fixed format for commit messages

[feat|keep|fix] (affected file or area) Change desc in short and present tense

feat stands for feature, use it when you have added some new features

keep stands for housekeeping, and should be used when the functioning of the code hasn't been changed, but it has been refactored, commented or linted.

fix stands for fix, use it when you fix some issue in the code

You can look at recent commits to see examples. Please don't commit a lot of changes at once, break it down into separate commits.

Things to do before committing

• Take a look over the code you have added or changed. Make sure it is readable and properly commented.
• run the lint script before committing (npm run lint or yarn lint)
• • run the docs script to rebuild docs before committing (npm run docs or yarn docs)