-
Notifications
You must be signed in to change notification settings - Fork 422
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
clean up markdown files and comments for next steps
- Loading branch information
Yifei Zhang
committed
Apr 5, 2013
1 parent
3f8ccda
commit 822f61d
Showing
3 changed files
with
26 additions
and
16 deletions.
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
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 |
---|---|---|
@@ -1,11 +1,18 @@ | ||
# FontCustom Contributing Checklist | ||
# FontCustom Contributing Guidelines | ||
|
||
First, thanks for your interest in making FontCustom better! This project was born out of an over-heard conversation between two devs in a coffee shop — it's come a long ways thanks to the support of kind folks like you. | ||
Thanks for helping make FontCustom better! This project was born out of an over-heard conversation between two devs in a coffee shop — it's come a long ways thanks to the support of folks like you. | ||
|
||
## A short list to help you get started: | ||
## Conventions | ||
|
||
* Check out [issues]() for ideas. Is someone else working on something similar? | ||
* Fork the repo and work out of a named topic branch, a la `git checkout -b my_sweet_contribution`. Please don't work directly off `master`. | ||
* Run tests with `guard`. | ||
* Add/improve tests for your contributions. | ||
* Submit a pull request! | ||
We try to follow the [Github ruby styleguide](https://github.com/styleguide/ruby) as much as possible. | ||
|
||
If you catch a typo or a particularly unsightly piece of code — please _do_ let us know. No such thing as too small of an improvement. | ||
|
||
## Process | ||
|
||
* Visit [issues](https://github.com/FontCustom/fontcustom/issues) for ideas. | ||
* Fork the repo if you haven't done so already. | ||
* Create a topic branch. `git checkout -b my_sweet_feature` | ||
* Add tests. Run tests with `rake`. | ||
* Develop your feature. | ||
* Once all tests are passing, submit a pull request! |
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