Skip to content

Latest commit

 

History

History
64 lines (37 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

64 lines (37 loc) · 3.24 KB
Raw

Contributing to Helix-CLI

This project is an Open Development/Inner Source project and welcomes contributions from everyone who finds it useful or lacking.

Code Of Conduct

This project adheres to the Adobe code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to cstaub at adobe dot com.

Contributor License Agreement

All third-party contributions to this project must be accompanied by a signed contributor license. This gives Adobe permission to redistribute your contributions as part of the project. Sign our CLA! You only need to submit an Adobe CLA one time, so if you have submitted one previously, you are good to go!

Things to Keep in Mind

This project uses a commit then review process, which means that for approved maintainers, changes can be merged immediately, but will be reviewed by others.

For other contributors, a maintainer of the project has to approve the pull request.

Before You Contribute

  • Check that there is an existing issue in GitHub issues
  • Check if there are other pull requests that might overlap or conflict with your intended contribution

How to Contribute

  1. Fork the repository
  2. Make some changes on a branch on your fork
  3. Use npm run check to make sure your code can run the tests and adheres to the style guide
  4. Create a pull request from your branch

In your pull request, outline:

  • What the changes intend
  • How they change the existing code
  • If (and what) they breaks
  • Start the pull request with the GitHub issue ID, e.g. #123

Lastly, please follow the pull request template when submitting a pull request!

Coding Styleguides

We enforce a coding styleguide using eslint. As part of your build, run npm run lint to check if your code is conforming to the style guide. We do the same for every PR in our CI, so PRs will get rejected if they don't follow the style guide.

You can fix some of the issues automatically by running npx eslint . --fix.

Commit message format

We use semantic-release for release management and require that all commits are properly formatted using the Angular Commit Message Conventions

In order to help you craft a good commit message, we added commitizen as dev dependency, so you can just run

$ npm run commit

How Contributions get Reviewed

One of the maintainers will look at the pull request within one week. Feedback on the pull request will be given in writing, in GitHub.

Release Management

Releasing is done using semantic-release, and every (relevant) commit to the master branch gets released automatically. The release will update the version number and add the recent changes to the CHANGELOG.md. It will also create a release in github and finally publish the package to the Adobe organization on npmjs.org.