dfx.sk/dfx-jekyll-mdl
1
0
Fork 0
Code Issues Releases Activity

Create CONTRIBUTING.md file for guides

Browse source
This commit is contained in:
Oscar Cortez 2015-07-18 21:40:13 -06:00
parent eb281d6a59
commit 157c7353f4
1 changed files with 76 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

76
CONTRIBUTING.md Normal file
View file

@ -0,0 +1,76 @@
# Contributing to jekyll-mdl
:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
The following is a set of guidelines for contributing to jekyll-mdl.
These are just guidelines, not rules, use your best judgment and feel free to
propose changes to this document in a pull request.
## Submitting Issues
* You can create an issue [here](https://github.com/gdg-managua/jekyll-mdl/issues/new),
and include as many details as possible with your report.
* Include the version of Jekyll you are using, the OS and the browser version and name.
* Include screenshots and animated GIFs whenever possible; they are immensely
helpful.
* Include the behavior you expected and other places you've seen that behavior
such as Emacs, vi, Xcode, etc.
* Check the web console for errors to include. If you can reproduce the error, use this approach to get the
full stack trace and include it in the issue.
* Perform a [cursory search](https://github.com/gdg-managua/jekyll-mdl/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+)
to see if a similar issue has already been submitted.
* Please setup a [profile picture](https://help.github.com/articles/how-do-i-set-up-my-profile-picture)
to make yourself recognizable and so we can all get to know each other better.
## Pull Requests
* Include screenshots and animated GIFs in your pull request whenever possible.
* Follow the [Material Design](https://www.google.com/design/spec/material-design/introduction.html) styleguides.
* End files with a newline.
* Please open an issue and reference this with your pull request
* See the [pull request guide](#pull-request-and-issue-styleguide)
## 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
* Consider starting the commit message with an applicable emoji:
* :art: `:art:` when improving the format/structure of the code
* :racehorse: `:racehorse:` when improving performance
* :non-potable_water: `:non-potable_water:` when plugging memory leaks
* :memo: `:memo:` when writing docs
* :penguin: `:penguin:` when fixing something on Linux
* :apple: `:apple:` when fixing something on Mac OS
* :checkered_flag: `:checkered_flag:` when fixing something on Windows
* :bug: `:bug:` when fixing a bug
* :fire: `:fire:` when removing code or files
* :white_check_mark: `:white_check_mark:` when adding tests
* :lock: `:lock:` when dealing with security
* :arrow_up: `:arrow_up:` when upgrading dependencies
* :arrow_down: `:arrow_down:` when downgrading dependencies
* :shirt: `:shirt:` when removing linter warnings
## Pull request and Issue Styleguide
```
### DESCRIPTION
The jekyll-mdl exploded my browser, some performance errors appear.
### Trace
Here is the stack trace.
### STEPS
1. Make a bomb.
2. Activate the bomb.
3. Place the bomb near of your browser.
4. RUN!.
5. The browser exploded.
### EXPECTED
The jekyll-mdl dont exploded my browser.
### REALITY
The jekyll-mdl exploded my browser.
```