Skip to content

Latest commit

 

History

History
141 lines (99 loc) · 4.61 KB

CONTRIBUTING.md

File metadata and controls

141 lines (99 loc) · 4.61 KB
Raw

Contributing to my-awesome-package

Thank you for your interest in this project and your aims to improving it. This guide will give you the most important info on how to contribute properly in order to get your pull requests accepted.

Disclose security vulnerabilities

First things first: We appreciate every help to improve security!

However, please read our security policy, before taking actions.

Guiding principles

Before contributing to this project, it's' important to understand how this project and it's collaborators views itself regarding its scope and purpose.

Development

If you want to fix bugs or add new features, please read this chapter and it's sections carefully!

No PR without issue

Please make sure your commitment will be appreciated by first opening an issue and discuss, whether this is a useful addition to the project.

Work on a bug or a new feature

First, clone and install this project from source via

$ git clone [email protected]:me/my-project.git
$ cd my-project
$ npm install

From here you can run several scripts for development purposes:

$ npm run lint           # runs the linter
$ npm run lint:fix       # runs the linter; fixes simple issues
$ npm run test           # runs the tests once
$ npm run test:watch     # runs the tests; reloads on code-changes
$ npm run test:coverage  # runs the tests including coverage
$ npm run docs           # generates the API docs
$ npm run build          # generates the final distributable files

To work on a new feature or a fix please create a new branch:

$ git checkout -b feature-xyz # or fix-xyz

Coding rules

  • Linter-pass: the linter must pass
  • Unit-testing: all features or bug fixes must be tested by specs
  • Documentation: all public APIs / methods must be documented

Commit message convention

We use a commit convention, inspired by angular commit message format with ticket number at the end of summary:

<type>(<scope>): <short summary> #<issue number>

Summary in present tense. Not capitalized. No period at the end. The and

fields are mandatory, the () and # field is optional.

Run the tests before committing

Please always make sure your code is passing linter and tests before committing. By doing so you help to make reviews much easier and don't pollute the history with commits, that are solely targeting lint fixes.

You can run the tests via

$ npm run test

or

$ npm run test:coverage

to see your coverage.

Open a pull request (PR)

Once you have implemented your changes and tested them locally, please open a pull request.

Note: sometimes a pull request (PR) is also referred to as merge request (MR).

Fundamental PR requirements

There are a few basic requirements for your pull request to become accepted:

  • Make sure to open your pull request to target the master branch
  • Make sure you are working on a branch, other than master; usually you can name the branch after the feature or fix you want to provide
  • Resolve any merge conflicts (usually by keeping your branch updated with master)
  • Have a clear description on what the PR does, including any steps necessary for testing, reviewing, reproduction etc.
  • Link to the existing issue
  • Added functions or changed functions need to get documented in compliance with JSDoc
  • Make sure all CI Tests are passing

Also make sure, to comply with the following list:

  • Do not work on master directly
  • Do not implement multiple features in one pull request (this includes bumping versions of dependencies that are not related to the PR/issue)
  • Do not bump the release version (unless you are a maintainer)
  • Do not edit the Changelog as this will be done after your PR is merged
  • Do not introduce tight dependencies to a certain package that has not been approved during the discussion in the issue

Review process

Finally, your PR needs to pass the review process:

  • A certain amount of maintainers needs to review and accept your PR
  • Please expect change requests! They will occur and are intended to improve the overall code quality.
  • If your changes have been updated please re-assign the reviewer who asked for the changes
  • Once all reviewers have approved your PR it will be merged by one of the maintainers 🎉

After merge

Please delete your branch after merge.