Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 50 lines (41 sloc) 2.252 kb
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
1 # Hi there!
2
3 I see you are interested in contributing. That is wonderful. I love
4 contributions.
5
6 I guarantee that there are bugs in this software. And I guarantee that there is
7 a feature you want that is not in here yet. As such, any and all bugs reports
8 are gratefully accepted, bugfixes even more so. Helping out with bugs is the
9 easiest way to contribute.
10
11
12 ## The Quick Version
13
14 * Have a [GitHub Account][].
15 * Search the [GitHub Issues][] and see if your issue already present. If so
16 add your comments, :thumbsup:, etc.
17 * Issue not there? Not a problem, open up a [new issue][].
18 * **Bug reports** please be as detailed as possible. Include:
19 * full ruby engine and version: `ruby -e 'puts RUBY_DESCRIPTION'`
20 * operating system and version
4514ac0 @copiousfreetime update contributors
authored
21 * version of amalgalite `ruby -rubygems -e "require 'amalgalite'; puts Amalgalite::VERSION"`
22 * as much detail about the bug as possible so I can replicate it. Feel free
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
23 to link in a [gist][]
24 * **New Feature**
25 * What the new feature should do.
26 * What benefit the new feature brings to the project.
27 * Fork the [repo][].
28 * Create a new branch for your issue: `git checkout -b issue/my-issue`
29 * Lovingly craft your contribution:
4514ac0 @copiousfreetime update contributors
authored
30 * `rake develop` to get started, or if you prefer bundler `rake develop:using_bundler && bundle`.
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
31 * `rake test` to run tests
4514ac0 @copiousfreetime update contributors
authored
32 * Make sure that `rake test` passes. It's important, I said it twice.
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
33 * Add yourself to the contributors section below.
34 * Submit your [pull request][].
35
36 # Contributors
37
4514ac0 @copiousfreetime update contributors
authored
38 * [Jeremy Hinegardner](https://github.com/copiousfreetime)
39 * [Jos Backus](https://github.com/josb)
40 * [Alex Young](https://github.com/regularfry)
41 * [Michael Granger](https://github.com/ged)
42 * [Alex Young](https://github.com/bmalex)
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
43
44 [GitHub Account]: https://github.com/signup/free "GitHub Signup"
4514ac0 @copiousfreetime update contributors
authored
45 [GitHub Issues]: https://github.com/copiousfreetime/amalgalite/issues "Amalgalite Issues"
46 [new issue]: https://github.com/copiousfreetime/amalgalite/issues/new "New Amalgalite Issue"
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
47 [gist]: https://gist.github.com/ "New Gist"
4514ac0 @copiousfreetime update contributors
authored
48 [repo]: https://github.com/copiousfreetime/amalgalite "Amalgalite Repo"
a9b8414 @copiousfreetime Switch to "fixme" style project structure
authored
49 [pull request]: https://help.github.com/articles/using-pull-requests "Using Pull Requests"
Something went wrong with that request. Please try again.