Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
45 lines (28 loc) · 1.45 KB

CONTRIBUTING.md

File metadata and controls

45 lines (28 loc) · 1.45 KB

Contributing to VERDI

First of all: Thank you!

Bugs & Feature Requests

You can file bugs on the issues tracker, and tag them with 'bug'. Feel free to discuss features there, too.

Good report structure

Please include the following four things in your report:

Please include a small script and/or actions taken within the GUI to explain the problem.

  1. What you did.
  2. What you expected to happen.
  3. What happened instead.

The more information the better.

Contributing Code and Documentation

It's easy to contribute code to VERDI:

  1. Fork VERDI.
  2. Create a topic branch - git checkout -b my_branch
  3. Push to your branch - git push origin my_branch
  4. Make sure the code follows the contributing guidelines below.
  5. Create a Pull Request from your branch.
  6. That's it!

First Time VERDI Contributors to the Code and Documentation

Submitting your first pull request can be a little daunting. If this is your first Open Source contribution, please mention it in your pull request and we will help guide you through the process.

Contributing Guidelines

  1. Recommend editing within GitHub or using the Atom Text Editor.
  2. Please pre-view your github markdown prior to committing changes.

For Java developers:

  1. Please use well written git commit messages.