Skip to content

Commit

Permalink
🔧 Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
marcobrunodev committed Nov 20, 2019
1 parent 2da9b8a commit 775e4b6
Showing 1 changed file with 50 additions and 0 deletions.
50 changes: 50 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
## Contributing

This project is released under the MPL 2.0 license.
Before implementing new features and changes, feel free to [submit an issue](https://github.com/CollabCodeTech/collabcodetraining-api-email/issues/new). We're going to talk here :stuck_out_tongue_winking_eye:.

### Code of Conduct

This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]).

### Issues and Questions

We have an official [Discord](https://discord.gg/YeeEAYj) server where we can give helpful advices if you have questions.

## How to submit a pull request?

1. Fork [this repository](https://github.com/CollabCodeTech/collabcodetraining-api-email/fork).
2. Create a new branch with the feature name. (Eg: feature/chat-support, hotfix/website-header)
3. Make your changes.
4. Commit your changes. Please follow the [styleguides](#styleguides)
5. Push your changes.
6. Submit your pull request.

We use [GitFlow](https://nvie.com/posts/a-successful-git-branching-model/) so unless your PR is a `hotfix`, your feature branch must be created from the `develop` branch.

**TIP:** This [Git extension](https://github.com/nvie/gitflow) makes Git Flow a piece of cake. GitKraken also has [built-in support](https://support.gitkraken.com/git-workflows-and-extensions/git-flow/) for GitFlow

## Styleguides

### Git Commit Styleguide

- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- Consider starting the commit message with an applicable emoji:
- :art: `:art:` when improving the format/structure of the code
- :zap: `:zap:` when improving performance
- :pencil: `:pencil:` when writing docs
- :penguin: `:penguin:` when fixing something on Linux
- :apple: `:apple:` when fixing something on macOS
- :checkered_flag: `:checkered_flag:` when fixing something on Windows
- :bug: `:bug:` when fixing a bug
- :fire: `:fire:` when removing code or files
- :green_heart: `:green_heart:` when fixing the CI build
- :white_check_mark: `:white_check_mark:` when adding or updating tests
- :lock: `:lock:` when dealing with security
- :arrow_up: `:arrow_up:` when upgrading dependencies
- :arrow_down: `:arrow_down:` when downgrading dependencies
- :rotating_light: `:rotating_light:` when removing linter warnings
- Full emoji reference in [gitmoji](https://gitmoji.carloscuesta.me/)

0 comments on commit 775e4b6

Please sign in to comment.