Skip to content

Commit

Permalink
Sync contributing with wiki.
Browse files Browse the repository at this point in the history
  • Loading branch information
bkloppenborg committed Dec 7, 2014
1 parent 4ff70f6 commit 0a19f82
Showing 1 changed file with 53 additions and 10 deletions.
63 changes: 53 additions & 10 deletions CONTRIBUTING.md
@@ -1,15 +1,53 @@
# Contributing to SIMTOI #
# Contributing to SIMTOI

## Reporting Issues ##
So you are interested in helping us improve SIMTOI? That's awesome! We have
put together some guidelines that should help you get started quickly and
easily. Thank you for stopping by!

We value your feedback about issues you encounter. The more information you
provide the easier it is for developers to resolve the problem.
## TL; DR

Issues should be reported to the [issue tracker](https://github.com/bkloppenborg/simtoi/issues?state=open).
If you need help with SIMTOI, please
[consult the documentation](https://github.com/bkloppenborg/simtoi/wiki)
first. If your question is not answered there, you may contact either
[Brian Kloppenborg](brian@kloppenborg.net) or [Fabien Baron](fbaron@gsu.edu)
with questions.
If you are [submitting a bug report](#reporting-issues)
please be sure to include as much information as possible so that we may
replicate and fix the issue.
If you have some code that you want to pull-request, please base your contribution
against the current development branch and submit your pull request against `develop`.

Issues can also be used to submit feature requests.
## Bug reports

## Submitting Pull Requests ##
A bug is a _demonstrable problem_ that is caused by code in the repository.
Good bug reports are extremely helpful. Thank you!

Guidelines for bug reports

1. **Use github issue search** - check to see if the issue has already been reported
2. **Check to see if the issue has been fixed** - Attempt to replicae the issue by using
the latest `develop` branch.
3. **Isolate the problem** - ideally create a reduced test case where the bug happens
4. **Include as much information as possible** - tell us which operating system (vendor
and version) you are using, what video card you are using, and any other relevant
information you deem useful to the bug report.

Once you have all of this information, bugs should be reported to the
[issue tracker](https://github.com/bkloppenborg/simtoi/issues?state=open).

## Feature requests

We are always interested in improving SIMTOI by adding additional functionality,
but before you make a suggestion please:

1. Search for existing
[enhancements in the issue tracker](https://github.com/bkloppenborg/simtoi/labels/enhancement)
to see if someone else has requested a similar or related feature

2. Remember, it is _up to you_ to make a strong case to convince the project leads
about the merit of the feature.

## Submitting Pull Requests

Base your changes on `master` but submit your pull-request to `develop`. This
can be changed by clicking the "Edit" button on the pull-request page. The
Expand All @@ -19,7 +57,12 @@ into the stable `master` branch.
Please try to rebase your changes on the current master branch before
submitting. This keeps the git history cleaner and easier to understand.

## Support ##
## Documentation

All of our documentation can be found on the
[SIMTOI wiki](https://github.com/bkloppenborg/simtoi/wiki).
If you would like to write some documentation, please coordinate with either
Brian or Fabien (contact information above). If like to write, but need a little
inspiration, check out our list of items needing documentation on the
[issue tracker](https://github.com/bkloppenborg/simtoi/labels/documentation).

Feel free to send an email to bkloppenborg@gmail.com with any problems or
questions.

0 comments on commit 0a19f82

Please sign in to comment.