Skip to content

Commit

Permalink
chore: update CONTRIBUTING.md (vuestorefront#6615)
Browse files Browse the repository at this point in the history
  • Loading branch information
filipsobol authored Jan 21, 2022
1 parent ecb2687 commit 4c9fd9b
Showing 1 changed file with 2 additions and 37 deletions.
39 changes: 2 additions & 37 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,41 +22,6 @@ Please follow these guidelines when reporting issues:

## Want to contribute?

You consider contributing changes to our framework, this is awesome!
We very much appreciate every contribution and do our best to review them in a reasonable time.

Please consider these guidelines when filing a pull request:

- Follow the [Coding Rules](#coding-rules)
- Follow the [Commit Rules](#commit-rules)
- Make sure you rebased the current master branch when filing the pull request
- Squash your commits when filing the pull request
- Provide a short title with a maximum of 100 characters
- Provide a more detailed description containing
_ What you want to achieve
_ What you changed
_ What you added
_ What you removed

## Coding Rules

To keep the code base of our repository neat and tidy, we apply a set of rules to every change

> Coding standards
- `eslint` is king
- Favor micro library over swiss army knives (rimraf, ncp vs. fs-extra) - Just in case you really need one :)
- Be awesome

## Commit Rules

To help everyone with understanding the commit history of commits the following rules are enforced.

To make your life easier our repository is commitizen-friendly and provides the npm run-script `commit`.

> Commit standards
- [conventional-changelog](https://github.com/conventional-changelog)
- husky commit message hook available
- present tense
- maximum of 100 characters
- message format of `$type($scope): $message`
To create a Pull Request, please follow our [Branching model](https://docs.vuestorefront.io/v2/contributing/branching-model.html) and [How to submit a Pull Request](https://docs.vuestorefront.io/v2/contributing/how-to-submit-pull-request.html) documents.

0 comments on commit 4c9fd9b

Please sign in to comment.