Skip to content

Commit

Permalink
Create CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
EvilInsultGenerator authored Oct 31, 2016
1 parent 0c34101 commit dda46f4
Showing 1 changed file with 68 additions and 0 deletions.
68 changes: 68 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# Contributing To Evil Insult Generator

๐Ÿ‘๐ŸŽ‰ First off, thanks for taking the time to contribute! ๐ŸŽ‰๐Ÿ‘

The following is a set of guidelines for contributing to [Evil Insult Generator](https://evilinsult.com/), which are hosted on [GitHub](https://github.com/EvilInsultGenerator/).
These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

## What should I know before I get started?

### Code of Conduct

This project adheres to the [Contributor Covenant code of conduct](https://contributor-covenant.org/version/1/4/).
By participating, you are expected to uphold this code. Please report unacceptable behavior to [marvin@evilinsult.com](mailto:marvin@evilinsult.com).

### Contact

If you have any questions or are unsure about something just drop a line to [marvin@evilinsult.com](mailto:marvin@evilinsult.com).

### Design Decisions

If you plan to make a significant decision in how to maintain the project and what it can or cannot support please send an email beforehand.

## How Can I Contribute?

### Reporting Bugs

This section guides you through submitting a bug report for [Evil Insult Generator](https://evilinsult.com/) software. Following these guidelines helps maintainers and the community understand your report ๐Ÿ“, reproduce the behavior ๐Ÿ“ฑ๐Ÿ’ป๐ŸŽฎ, and find related reports ๐Ÿ”Ž.

Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for [Evil Insult Generator](https://evilinsult.com/), including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion ๐Ÿ“ and find related suggestions ๐Ÿ”Ž.

Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible.

### Pull Requests

+ Include screenshots and animated GIFs in your pull request whenever possible.
+ Create a [branch](https://guides.github.com/introduction/flow/) for your edit

### Git Commit Messages

+ 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
+ When only changing documentation, include [ci skip] in the commit description
+ Consider starting the commit message with an applicable emoji:

๐ŸŽจ :art: when improving the format/structure of the code
๐ŸŽ :racehorse: when improving performance
๐Ÿšฑ :non-potable_water: when plugging memory leaks
๐Ÿ“ :memo: when writing docs
๐Ÿง :penguin: when fixing something on Linux
๐ŸŽ :apple: when fixing something on macOS
๐Ÿ :checkered_flag: when fixing something on Windows
๐Ÿ› :bug: when fixing a bug
๐Ÿ”ฅ :fire: when removing code or files
๐Ÿ’š :green_heart: when fixing the CI build
โœ… :white_check_mark: when adding tests
๐Ÿ”’ :lock: when dealing with security
โฌ†๏ธ :arrow_up: when upgrading dependencies
โฌ‡๏ธ :arrow_down: when downgrading dependencies
๐Ÿ‘• :shirt: when removing linter warnings
__Thank you so much! ๐Ÿ˜˜__

0 comments on commit dda46f4

Please sign in to comment.