Skip to content

Latest commit

 

History

History
83 lines (62 loc) · 3.39 KB

CONTRIBUTING.md

File metadata and controls

83 lines (62 loc) · 3.39 KB
Raw

Contributing

Guidelines

  • Coding Standard: Linting errors are checked by TSLint and stylistic issues are handled by Prettier. Keeping a consistent style throughout the codebase keeps the cognitive load low for all contributors and keeps the code style homogeneous.

  • Node 8 LTS: github-backup-cli has a minimum Node version requirement of 8.0.0. Pull requests must not require a Node version greater than that unless the feature is enabled/backported via TypeScript.

  • Add tests: All pull requests should include unit tests to ensure the change works as expected and to prevent regressions.

  • Document any change in behaviour: Make sure any documentation is kept up-to-date.

  • Consider our release cycle: We try to follow SemVer v2. Randomly breaking public APIs is not an option.

  • Use Git Flow: Don't ask us to pull from your master branch. Set up Git Flow and create a new feature branch from develop.

  • One pull request per feature: If you want to do more than one thing, send multiple pull requests.

  • Send coherent history: Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please rebase or squash them before submitting.

  • Useful commit messages: Commit messages should be short and descriptive, and follow Conventional Changelog Standard. The best way to do this is to use yarn commit instead of interacting with Git directly.

Running tests

In order to contribute, you'll need to checkout the source from GitHub and install dependencies using Yarn:

git clone https://github.com/EndemolShineGroup/github-backup-cli.git
cd github-backup-cli
yarn
yarn test

Releasing a new version

To release a new version, simply merge develop into master and let the CI take care of everything. This includes Git tags, changelog generation and NPM releases.

Reporting a security vulnerability

We want to ensure that github-backup-cli is secure for everyone. If you've discovered a security vulnerability, we appreciate your help in disclosing it to us in a responsible manner.

Publicly disclosing a vulnerability can put the entire community at risk. If you've discovered a security concern, please email us at [email protected] with [SECURITY] in the subject line. We'll work with you to make sure that we understand the scope of the issue, and that we fully address your concern. We consider correspondence sent to this email address our highest priority, and work to address any issues that arise as quickly as possible.

After a security vulnerability has been corrected, a security hotfix release will be deployed as soon as possible.

Happy coding!