This repository was archived by the owner on Oct 12, 2023. It is now read-only.
forked from laserlemon/figaro
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Showing
2 changed files
with
49 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
# Contributing to Figaro | ||
|
||
Figaro is open source and contributions from the community are encouraged! No | ||
contribution is too small. | ||
|
||
Please consider: | ||
|
||
* Adding a feature | ||
* Squashing a bug | ||
* Writing documentation | ||
* Fixing a typo | ||
* Correcting [style](https://github.com/styleguide/ruby) | ||
|
||
## How do I contribute? | ||
|
||
For the best chance of having your changes merged, please: | ||
|
||
1. [Fork](https://github.com/laserlemon/figaro/fork) the project. | ||
2. [Write](http://en.wikipedia.org/wiki/Test-driven_development) a failing test. | ||
3. [Commit](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) changes that fix the tests. | ||
4. [Submit](https://github.com/laserlemon/figaro/pulls) a pull request with *at least* one animated GIF. | ||
5. Be patient. | ||
|
||
If your proposed changes only affect documentation, include the following on a | ||
new line in each of your commit messages: | ||
|
||
``` | ||
[ci skip] | ||
``` | ||
|
||
This will signal [Travis](https://travis-ci.org) that running the test suite is | ||
not necessary for these changes. | ||
|
||
## Bug Reports | ||
|
||
If you are experiencing unexpected behavior and, after having read Figaro's | ||
documentation, are convinced this behavior is a bug, please: | ||
|
||
1. [Search](https://github.com/laserlemon/figaro/issues) existing issues. | ||
2. Collect enough information to reproduce the issue: | ||
* Figaro version | ||
* Ruby version | ||
* Rails version | ||
* Specific setup conditions | ||
* Description of expected behavior | ||
* Description of actual behavior | ||
3. [Submit](https://github.com/laserlemon/figaro/issues/new) an issue. | ||
4. Be patient. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters