File: CONTRIBUTING.md

package info (click to toggle)
ruby-launchy 2.5.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, sid
  • size: 308 kB
  • sloc: ruby: 1,288; makefile: 6
file content (60 lines) | stat: -rw-r--r-- 2,754 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# Hi there!

I see you are interested in contributing. That is wonderful. I love
contributions.

I guarantee that there are bugs in this software. And I guarantee that there is
a feature you want that is not in here yet. As such, any and all bugs reports
are gratefully accepted, bugfixes even more so. Helping out with bugs is the
easiest way to contribute.


## The Quick Version

* Have a [GitHub Account][].
* Search the [GitHub Issues][] and see if your issue already present. If so
  add your comments, :thumbsup:, etc.
* Issue not there? Not a problem, open up a [new issue][].
    * **Bug reports** please be as detailed as possible. Include:
        * full ruby engine and version: `ruby -e 'puts RUBY_DESCRIPTION'`
        * operating system and version
        * version of launchy `ruby -rubygems -Ilib -e "require 'launchy'; puts Launchy::VERSION"`
        * as much detail about the bug as possible so I can replicate it. Feel free
          to link in a [gist][]
    * **New Feature**
        * What the new feature should do.
        * What benefit the new feature brings to the project.
* Fork the [repo][].
* Create a new branch for your issue: `git checkout -b issue/my-issue`
* Lovingly craft your contribution:
    * `rake develop` to get started
    * `bundle exec rake test` to run tests
* Make sure that `bundle exec rake test` passes. It's important, I said it twice.
* Add yourself to the contributors section below.
* Submit your [pull request][].

# Contributors

* [Jeremy Hinegardner](https://github.com/copiousfreetime)
* [Mike Farmer](https://github.com/mikefarmer)
* [Suraj N. Kurapati](https://github.com/sunaku)
* [Postmodern](https://github.com/postmodern)
* [Stephen Judkins](https://github.com/stephenjudkins)
* [Mariusz Pietrzyk](https://github.com/wijet)
* [Bogdan Gusiev](https://github.com/bogdan)
* [Miquel Rodríguez Telep](https://github.com/mrtorrent)
* [Chris Schmich](https://github.com/schmich)
* [Gioele Barabucci](https://github.com/gioele)
* [Colin Noel Bell](https://github.com/colbell)
* [Mark J. Lehman](https://github.com/supremebeing7)
* [Cédric Félizard](https://github.com/infertux)
* [Daniel Farina](https://github.com/fdr)
* [Jack Turnbull](https://github.com/jackturnbull)
* [Jeremy Moritz](https://github.com/jeremymoritz)

[GitHub Account]: https://github.com/signup/free "GitHub Signup"
[GitHub Issues]:  https://github.com/copiousfreetime/launchy/issues "Launchy Issues"
[new issue]:      https://github.com/copiousfreetime/launchy/issues/new "New Launchy Issue"
[gist]:           https://gist.github.com/ "New Gist"
[repo]:           https://github.com/copiousfreetime/launchy "Launchy Repo"
[pull request]:   https://help.github.com/articles/using-pull-requests "Using Pull Requests"