|
1 |
| -# Cylc UI: How to Contribute |
| 1 | +# Cylc: How to Contribute |
2 | 2 |
|
3 |
| -## Report Bugs |
| 3 | +Thanks for you interest in the Cylc project! |
4 | 4 |
|
5 |
| -Report bugs by opening an issue [on |
6 |
| -Github](https://github.com/cylc/cylc-ui/issues). Give the version |
7 |
| -affected by the bug (you should test the latest release if possible) and a |
8 |
| -recipe to reproduce the problem. |
| 5 | +Contributions are welcome, please open an issue to discuss changes before |
| 6 | +raising a pull request. |
9 | 7 |
|
10 |
| -## Request Enhancements |
| 8 | +You can also get in touch via: |
| 9 | + |
| 10 | +* The developers chat: [](https://matrix.to/#/#cylc-general:matrix.org) |
| 11 | +* The forum: [](https://cylc.discourse.group/) |
| 12 | + |
| 13 | + |
| 14 | +## New Contributors |
| 15 | + |
| 16 | +Please read the [CLA](#contributor-licence-agreement-and-certificate-of-origin). |
| 17 | + |
| 18 | +Please add your name to the |
| 19 | +[Code Contributors](#code-contributors) section of this file as part of your |
| 20 | +first Pull Request (for each Cylc repository you contribute to). |
11 | 21 |
|
12 |
| -Request enhancements by opening an issue at [Github |
13 |
| -](https://github.com/cylc/cylc-ui/issues). Describe your use case in |
14 |
| -detail. |
15 | 22 |
|
16 | 23 | ## Contribute Code
|
17 | 24 |
|
18 |
| -All contributions to project are made via Pull Requests against the *master* |
19 |
| -branch of [cylc/cylc-ui](https://github.com/cylc/cylc-ui). |
20 |
| -Non-trivial developments must be discussed and agreed in advance in a |
21 |
| -[Issue](https://github.com/cylc/cylc-ui/issues) as the team may not |
22 |
| -be able to consider large changes that appear out of the blue. New |
23 |
| -contributors should add their details to the [Code Contributors |
24 |
| -](#code-contributors) section of this file as part of their first Pull |
25 |
| -Request, and reviewers are responsible for checking this before merging the |
26 |
| -new branch into *master*. |
| 25 | +**Enhancements** are made on the `master` branch. |
| 26 | + |
| 27 | +**Bugfixes** are made on the branch of the same name as the issue's milestone. |
| 28 | +E.G. if the issue is on the `8.0.x` milestone, branch off of `8.0.x` to |
| 29 | +develop your bugfix, then raise the pull request against the `8.0.x` branch. |
| 30 | +We will later merge the `8.0.x` branch into `master`. |
| 31 | + |
| 32 | +Feel free to ask questions on the issue or developers chat if unsure about |
| 33 | +anything. |
| 34 | + |
27 | 35 |
|
28 | 36 | ## Code Contributors
|
29 | 37 |
|
|
0 commit comments