Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 3.24 KB

CONTRIBUTING.md

File metadata and controls

72 lines (50 loc) · 3.24 KB
Raw

Contributing Guidelines

Prior to contributing to ChronoZoom, you are required to sign an OuterCurve Contributors Agreement to assign the copyright of your contributions to the foundation. Email [email protected] and ask to be added as an OuterCurve contributor.

Setup and Installation

See the ChronoZoom Developer's Guide for detailed instructions on setting up a development environment and deploying ChronoZoom to Azure.

Pull Requests

  1. Before doing anything else, merge the upstream development branch into your topic branch:

    git pull blessed master

  2. Push your topic branch up to your fork:

    git push origin <+topicBranch:topicBranch>

  3. Open a Pull Request with a clear title and description.

Git Hygiene

While working, commit your changes in logical chunks. Use Git's interactive rebase feature to tidy up your commits before making them public. Note that this should not be done after pushing changes to any remote repository. Additionally, be sure to observe these git commit message guidelines.

Code Style

  • Use tools such as Stylecop, Code Analysis, and Jetbrains Resharper to ensure that your code is conformant with project style guidelines.
  • Use the project's coding style, not your own. When in doubt, follow the existing code as an example of what to do.

Unit Tests

Prior to submitting you must run unit tests on your code.

Reporting Issues

A bug is a demonstrable problem that is caused by code in the repository.

Please read the following guidelines before you report an [issue][issues]:

  1. Use GitHub issue search to see if the issue has already been reported. If it has, please comment on the existing issue.

  2. Check whether the issue has been fixed — The latest master or development branch may already contain a fix.

  3. Isolate the demonstrable problem — make sure that the code in the project's repository is definitely responsible for the issue.

Please try to be as detailed as possible in your report.

Example of a good bug report:

Short and descriptive title

A summary of the issue and the browser/OS environment in which it occurs. If suitable, include the steps required to reproduce the bug.

  1. This is the first step
  2. This is the second step
  3. Further steps, etc.

<url> (a link to the test case)

Any other information you want to share that is relevant to the issue being reported. This might include the lines of code that you have identified as causing the bug, and potential solutions (and your opinions on their merits).

[File a bug report][issues]

Do not…

Please do not use the issue tracker for personal support requests.

Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.