Skip to content

Commit

Permalink
📝 Add GitMoji commit convention and contribution guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
6im0n committed Mar 11, 2024
1 parent a7bb5d6 commit 3357ad8
Showing 1 changed file with 49 additions and 0 deletions.
49 changes: 49 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
## GitMoji Commit Convention

We use the GitMoji convention for our commit messages. Each commit message should start with an emoji, followed by a verb in present tense, and a brief description of what was done. Here are the emojis we use and their meanings:

- ✨ for adding a feature
- ⚡ for improving a feature
- 🐛 for fixing a bug
- ✏️ for adding or updating headers or Makefile
- 🔀 for merging a branch into another
- 🚚 for changing the repository's structure (renaming or moving files)
- 🥅 for error handling
- ♻️ for Refactoring code in a better way
- 🚧 for work in progress
- 🔥 for removing code
- ⚰️ for removing deprecated/unused code
- 🚨 for fixing warnings
- 🎉 for initial commit
- 📝 for adding documentation
- ✅ for adding tests
- 🙈 for adding .gitignore
- 🔧 for adding or updating configuration files
- 🍱 for adding resources
- 🎨 for improving code structure/format
- 👷 for adding or updating files needed for continuous integration (CI)
- 🥚 for adding bonus or easter egg


Here's an example of a valid commit message:

```
✨ Add new feature to improve user experience
```

## Branching and Merging

- Do not push directly to the main branch.
- Create a branch related to the current issue and make a pull request (PR) to merge the branch.
- At least one person must approve the PR before it can be merged.

## Test Politics

- Criterion

## Code Quality

- Always maintain high-quality code.


Thank you for contributing to the Haskell Image Compressor !

0 comments on commit 3357ad8

Please sign in to comment.