Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.08 KB

CONTRIB.md

File metadata and controls

37 lines (26 loc) · 2.08 KB
Raw

Contributing to RIESLING

Welcome to RIESLING. Any help is very much appreciated.

These guidelines exist to make it easy to get involved and ensure that RIESLING is welcoming to everyone.

Asking Questions / Reporting Bugs

If you have general questions about how to use RIESLING programs, you can either open an issue.

If you think you have found a bug, then opening a Github issue is the preferred avenue. Please check whether an identical or similar issue already exists first. When opening a new issue, please give as much information as you can, including

  • The version of riesling you are using. Either give the version number if you downloaded the binaries, or a branch/git commit id if you compiled from source.
  • The operating system you are running on.
  • A description of the bug, including the full shell command you ran and any input files.

Contributing Changes

If you want to edit the RIESLING code yourself to fix a problem or implement a new feature, you are very welcome to! Please follow this model for submitting a Pull Request:

  • (Fork)[https://help.github.com/articles/fork-a-repo/] the riesling repo to your Github profile.
  • Clone this repo, then create a new branch.
  • Make your changes on this branch.
  • Run clang-format. Riesling has a .clang-format file to avoid wasting time arguing over style.
  • Squash/rebase your changes into a minimal number of commits.
  • Make sure your copy of the main branch is up to date, and if necessary rebase your branch to the latest commit.
  • Push your branch to Github.
  • Open a Pull Request.

Code of Conduct

  • Anyone who participates in the development of RIESLING is expected to show respect and courtesy to all other community members at all times.
  • Harrasment in any form towards any members will not be tolerated.
  • All communication should be appropraite for a professional audience including people of different backgrounds.
  • Be kind to others. Do not insult or put down other contributers.

Thanks

Above all, thank you for using or contributing to RIESLING. It really is appreciated.