Skip to content

Commit

Permalink
Document new way of naming commit messages (#330)
Browse files Browse the repository at this point in the history
  • Loading branch information
iampava committed Sep 20, 2021
1 parent 0e6df9e commit 989d880
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions CONTRIBUTING.md
Expand Up @@ -16,19 +16,27 @@ For points 2 & 3 get in touch with us via **social media** or **email** at [hell

## Commit Messages

Every commit should be "tagged" in such a way that it's easy to scan through them:
Every commit message should have an associated issue that describes the feature/bug/idea in more details.

1. `[FeatureName] Description` -> general commit when adding new features
The name of the commit should follow this format:

```
{issue_name} ({issue_url})
```

For example, the commit message for this issue: https://github.com/FrontEnd-ro/frontend.ro/issues/297 should be:

```
Upgrade to Next11 (https://github.com/FrontEnd-ro/frontend.ro/issues/297)
```

2. `[BUGFIX][FeatureName] Description` -> fixing bugs

3. `[FIXUP][FeatureName] Description` -> when immediately after a merge we discovered some bugs related to that feature.

4. `[DOCS] Description` -> modifying README.md, CONTRIBUTORS.md or anything related to documentation
### Exceptions

5. `[COSMETIC] Description` -> when commiting cosmetic fixes like indentation, eslint fixes, so on...
If we have commits that are only COSMETIC (ie: changing formatting but not actual code), we can simply name them by prepending `[COSMETIC]`.

6. `[REFACTOR][FeatureName] Description` -> when refactoring code without adding any new functionality
Example: `[COSMETIC] Fix eslint warnings`.

## FrontEnd Style Guide

Expand Down

0 comments on commit 989d880

Please sign in to comment.