Skip to content

Latest commit

 

History

History
64 lines (50 loc) · 3.42 KB

CONTRIBUTING.md

File metadata and controls

64 lines (50 loc) · 3.42 KB

Contributing

To contribute to this project, please observe the following guidelines.

To Make a Feature Suggestion:

  1. Make an account on github (or log in to an existing one)
  2. Describe your feature suggestion in detail in an issue
  3. Wait for a response. You should get a response within a week, but as with almost every open source project, paid employment comes first for the maintainer(s). If nobody has responded in a week, feel free to join our slack channel and ask "has anyone had time to look at issue #?"

See the front page README for details on joining the slack channel.

Please do not send email with requests, or expect a response to verbal/slack/chat based requests. If it doesn't have a ticket it probably won't get done.

To Submit a Bug Report:

  1. Make an account on github (or log in to an existing one)
  2. Open an issue and be sure to include
    1. General description of what you were attempting when you hit the bug
    2. The steps that reproduce the problem
    3. The expected result for the steps given
    4. The actual (bug) result for the steps given.
  3. Wait for a response. You should get a response within a week, but as with almost every open source project, paid employment comes first for the maintainer(s). If nobody has responded in a week, feel free to join our slack channel and ask "has anyone had time to look at issue #?"

See the front page README for details on joining the slack channel.

Please do not send bug reports via email with requests, or expect a response to verbal/slack/chat based requests. If it doesn't have a ticket it probably won't get done.

To Submit Code

(to fix a bug or implement a feature request)

  1. Make an account on github (or log in to an existing one)
  2. On the front page of this repository click the button on the upper right that says "fork" (it has a number right next to it).
  3. Go to your own profile and click repositories. You should see /jesterj in your repository list. This is your personal copy (don't worry it's free). Click on it.
  4. Clone your repository to your local machine
  5. Make your code changes, committing as many times as you like (with good comments)
  6. Push your changes to github as often as you like.
  7. When you are happy with the changes and want them added to this repository click create a pull request and select a branch in nsoft/jesterj as the base, and a branch in your fork as the "compare"
  8. Write a short comment describing your work and submit your pull request.
  9. Wait for a response. You shoudl get a response within a week, but as with almost every open source project, paid employment comes first for the maintainer(s). If nobody has responded in a week, feel free to join our slack channel and ask "has anyone had time to look at issue #?"

NOTE: You should develop your changes against the master branch, the committer accepting your pull request will handle any merges to other branches if applicable.

See the front page README for details on joining the slack channel.

Please do not send code via email with requests, or expect a response to verbal/slack/chat based requests. If it doesn't have a ticket it probably won't get done.

** DO NOT expect code pasted into the issue to be committed **