Skip to content

Commit

Permalink
Merge branch 'master' of github.com:/JordanRL/Newton
Browse files Browse the repository at this point in the history
  • Loading branch information
JordanRL committed Aug 26, 2015
2 parents 2888b10 + cf701b7 commit a0e16c6
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,21 @@

This document lays out the guidelines for contributing to this project.

## Reporting Bugs & Opening Issues

Please adhere to these guidelines when reporting bugs:

- If the bug exists in a specific class/method, provide that in the title.
- Provide as much detail as possible on how to reproduce the bug, including values.
- If you have a proposed way to solve the problem, please **reply to your bug report with your solution**, do not list it in the description of the issue.

If you want to open up an issue for any other reason, please adhere to these guidelines:

- Keep the title around 5-7 words.
- Do not include the words "feature" or synonyms in the title. We will handle that with tags.
- If you want something improved in a specific class, please mention that. Example title: *"Add 'cubit' conversion to Length class"*
- Discussion issues should start with a question (hence the discussion), so end the title in a question mark. :)

## Merge Acceptance Requirements

In order for your pull request to be merged, the merge itself must meet the following guidelines:
Expand All @@ -25,4 +40,4 @@ The following guidelines are greatly encouraged, although strict adherence is no
- The return value
- Comments describing information for the developer should accompany any public methods
- All methods should return some value. In other words, void is not considered a valid return value within this project.
- Units, and anything dealing with units, should always treat them as MUTABLE.
- Units, and anything dealing with units, should always treat them as MUTABLE.

0 comments on commit a0e16c6

Please sign in to comment.