Skip to content

Latest commit

 

History

History
41 lines (23 loc) · 1.7 KB

CONTRIBUTING.md

File metadata and controls

41 lines (23 loc) · 1.7 KB

Evervault

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/evervault/evervault-node.

Getting Started

To make life easier, this module features a code formatter/linter.

You will first need to install all of the dependencies with

npm install

after that is done, there are git hooks which need to be installed using husky, which can be done through

npm run prepare

We use one hook: pre-commit.

Code Formatting

The pre-commit hook ensures that code is formatted correctly. We use prettier for code formatting automatically, and if you want you can see the configuration in the .prettierrc file.

It should be possible to configure your editor to run prettier on save, which should make your life easier - have a look at editor support.

There is a test that is run whenever a pull request is made (npm run lint), so please ensure that your code is formatted correctly before committing!

Commit Formatting & Releases

We use changesets to version manage in this repo.

When creating a pr that needs to be rolled into a version release, do npx changeset, select the level of the version bump required and describe the changes for the change logs. DO NOT select major for releasing breaking changes without team approval.

To release:

Merge the version PR that the changeset bot created to bump the version numbers. This will bump the versions of the packages, create a git tag for the release, and release the new version to npm.