Skip to content

Commit

Permalink
update CONTRIBUTING
Browse files Browse the repository at this point in the history
  • Loading branch information
oliver-sanders committed Feb 20, 2023
1 parent de8abd0 commit 5996a81
Showing 1 changed file with 27 additions and 17 deletions.
44 changes: 27 additions & 17 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,37 @@
# Cylc: How to Contribute

## Report Bugs
Thanks for you interest in the Cylc project!

Report bugs by opening an issue at [Cylc Issues on
Github](https://github.com/cylc/cylc-flow/issues). Give the Cylc version
affected by the bug (you should test the latest release if possible) and a
recipe to reproduce the problem.
Contributions are welcome, please open an issue to discuss changes before
raising a pull request.

## Request Enhancements
You can also get in touch via:

* The developers chat: [![chat](https://img.shields.io/matrix/cylc-general:matrix.org)](https://matrix.to/#/#cylc-general:matrix.org)
* The forum: [![forum](https://img.shields.io/discourse/https/cylc.discourse.group/posts.svg)](https://cylc.discourse.group/)


## New Contributors

Please read the [CLA](#contributor-licence-agreement-and-certificate-of-origin).

Please add your name to the
[Code Contributors](#code-contributors) section of this file as part of your
first Pull Request (for each Cylc repository you contribute to).

Request enhancements by opening an issue at [Cylc Issues @
Github](https://github.com/cylc/cylc-flow/issues). Describe your use case in
detail.

## Contribute Code

All contributions to Cylc are made via Pull Requests against the *master*
branch of [cylc/cylc-flow](https://github.com/cylc/cylc-flow). Non-trivial
developments must be discussed and agreed in advance in a [Cylc
Issue](https://github.com/cylc/cylc-flow/issues) as the team may not be able to
consider large changes that appear out of the blue. New contributors should
add their details to the [Code Contributors](#code-contributors) section of
this file as part of their first Pull Request, and reviewers are responsible
for checking this before merging the new branch.
**Enhancements** are made on the `master` branch.

**Bugfixes** are made on the branch of the same name as the issue's milestone.
E.G. if the issue is on the `8.0.x` milestone, branch off of `8.0.x` to
develop your bugfix, then raise the pull request against the `8.0.x` branch.
We will later merge the `8.0.x` branch into `master`.

Feel free to ask questions on the issue or developers chat if unsure about
anything.


## Code Contributors

Expand Down Expand Up @@ -78,6 +87,7 @@ requests_).
(All contributors are identifiable with email addresses in the git version
control logs or otherwise.)


## Contributor Licence Agreement and Certificate of Origin

By making a contribution to this project, I certify that:
Expand Down

0 comments on commit 5996a81

Please sign in to comment.