1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
|
# How to Contribute
Thank you for your interest in contributing to SCRAM.
Contributions are accepted through [GitHub](https://help.github.com)
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.
[Issue Tracker]: https://github.com/rakhimov/scram/issues?utf8=%E2%9C%93&q=
[todo list]: https://scram-pra.org/doc/todo.html
[user mailing list]: https://groups.google.com/forum/#!forum/scram-users
## 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.
[Coding Style and Quality Assurance]: https://scram-pra.org/doc/coding_standards.html
[developer mailing list]: https://groups.google.com/forum/#!forum/scram-dev
[pull request]: https://help.github.com/articles/using-pull-requests/
## 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 License Agreement]: https://github.com/rakhimov/scram/blob/develop/ICLA.md
[CLA Assistant]: https://cla-assistant.io/
## 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.
[Contributor Code of Conduct]: https://github.com/rakhimov/scram/blob/develop/CODE_OF_CONDUCT.md
|
