Skip to content

Latest commit

 

History

History
79 lines (52 loc) · 4.12 KB

CONTRIBUTING.md

File metadata and controls

79 lines (52 loc) · 4.12 KB
Raw

Contributing

👋 Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.

Submitting a pull request

Pull Requests are used for adding new playbooks, roles, and documents to the repository, or editing the existing ones.

With write access

  1. Clone the repository (only if you have write access)
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change
  4. Push and submit a pull request
  5. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Without write access

  1. Fork and clone the repository
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change
  4. Push to your fork and submit a pull request
  5. Pat your self on the back and wait for your pull request to be reviewed and merged.

Commit Structure

All the Herbs organization libraries uses semantic release and commitizen to :

  • Generate changelog
  • Control version
  • Publish to npm via github actions Please use this format for commit messages (https://semver.org/).

By default herbs organization uses Angular Commit Message Conventions.

Tools such as commitizen or commitlint can be used to help contributors and enforce valid commit messages.

The table below shows which commit message gets you which release type when semantic-release runs (using the default configuration):

Commit message Release type
fix(pencil): stop graphite breaking when too much pressure applied Patch Release
feat(pencil): add 'graphiteWidth' option Minor Feature Release
perf(pencil): remove graphiteWidth option

BREAKING CHANGE: The graphiteWidth option has been removed.
The default graphite width of 10mm is always used for performance reasons.		 Major Breaking Release

To help with this task we have implemented the commitizen to all libraries, just follow those steps:

  • npm install -g commitizen
  • Write a lot of good code to contribute to herbs 🌿
  • git add yourChanges
  • git cz or npm run commit or npx cz instead git commit
  • git push

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write good commit messages.

Draft pull requests are also welcome to get feedback early on, or if there is something blocking you.

  • Create a branch with a name that identifies the user and nature of the changes (similar to user/branch-purpose)
  • Open a pull request

Labels for PR's and Issues

We have a list of labels that are used inside items and pull requests, please read and respect those labels.

Resources