Skip to content

Commit

Permalink
Adds CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Loren Rogers committed Mar 29, 2016
1 parent 5a16082 commit 5fd2a9d
Showing 1 changed file with 34 additions and 0 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Contributing

If you find this app useful, please consider contributing to its
development. There are plenty of wish-list features in the
[bug tracker][bugtracker].

To get started, fork the repo, have a look around, and try building
the gem:

gem build todo-curses.gemspec

This should succeed.

Then, [find an issue][bugtracker] (or log one) and add a comment saying that
you'd like to work on it.
(So that we don't end up with duplicate effort.)

## Developing

To make life a little easier, I've set up some Rake tasks.
If you create a `todo.txt.bak` file, you can run `rake reset`, which
will copy it into `todo.txt`. Then you can run `rake` and it will
open the app on this file.

## Submitting

Once it looks good, write up a [good commit message][commit].
Push to your fork and submit a pull request. Be sure to mention
the issue number you were working on in the bug tracker so that
they're linked up.

[bugtracker]: https://github.com/lorentrogers/jekylljournal/issues
[commit]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html

0 comments on commit 5fd2a9d

Please sign in to comment.