Skip to content

Latest commit

 

History

History
69 lines (49 loc) · 2.89 KB

CONTRIBUTING.md

File metadata and controls

69 lines (49 loc) · 2.89 KB
Raw

How to Contribute

Thank you for your interest in contributing to SCRAM. Contributions are accepted through GitHub Pull Requests and Issue Tracker.

Reporting Bugs, Suggesting Enhancements, Opening GitHub Issues

Please check for duplicates in the Issue Tracker and project todo list. If you are uncertain or have questions, consider posting on user mailing list. In bug reports, please supply as much information as feasible, such as the platform, version number, logs, and (sufficient) input.

GUI Issues and Commits

Prepend GUI issue and commit titles with "GUI:". For example, a GUI issue can be opened as "GUI: Crash with internal exception", and a git commit related to the GUI code can be "GUI: Fix the memory leak in Gate".

Developer Workflow

  1. Start by forking this repository and setting it as the upstream repository.
  2. Create your topic branch from the develop branch.
  3. Keep in sync your origin develop branch with the upstream develop branch.
  4. Develop your contributions following the Coding Style and Quality Assurance. Every commit should compile and pass tests.
  5. Keep your topic branch in sync with the develop branch by merging or rebasing your topic branch on top of the develop. Rebasing is highly recommended for streamlining the history. However, DO NOT rebase any commits that have been pulled/pushed anywhere else other than your own fork.
  6. Use the developer mailing list and Issue Tracker to stay in touch with the project development.
  7. Submit your pull request from your topic branch to the upstream develop branch.
  8. Your pull request will be reviewed by another developer before merging.

Contributor License Agreement

Upon pull requests, first time contributors will be asked to sign the Contributor License Agreement through CLA Assistant with a GitHub account. This license is for your protection as a contributor as well as the protection of SCRAM and its users; it does not change your rights to use your own contributions for any other purpose.

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project, you agree to abide by its terms.