From ab673dc007b027a793d3d9ac728917e9c728268a Mon Sep 17 00:00:00 2001 From: Tim Pillinger <26465611+wxtim@users.noreply.github.com> Date: Mon, 27 Feb 2023 12:01:13 +0000 Subject: [PATCH] remove pr and issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 31 ---------------- .github/ISSUE_TEMPLATE/feature-request.md | 20 ----------- .github/PULL_REQUEST_TEMPLATE.md | 27 -------------- CONTRIBUTING.md | 43 +++++++++++++---------- 4 files changed, 25 insertions(+), 96 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug-report.md delete mode 100644 .github/ISSUE_TEMPLATE/feature-request.md delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index c76ae246..00000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -name: Bug Report -about: Give as much information as you can, and be sure to search existing - Issues first. -title: '' -labels: bug -assignees: '' - ---- - -**Describe the bug** - - -**Release version(s) and/or repository branch(es) affected?** - - -**Steps to reproduce the bug** - - -**Expected behavior** - - -**Screenshots** - - -**Additional context** - - -**Pull requests welcome!** -This is an Open Source project - please consider contributing a bug fix -yourself (please read `CONTRIBUTING.md` before starting any work though). diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md deleted file mode 100644 index 47f9ba53..00000000 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature Request -about: Give as much information as you can, and be sure to search existing - Issues first. -title: '' -labels: '' -assignees: '' - ---- - -**Describe exactly what you would like to see in an upcoming release** - - -**Additional context** - - -**Pull requests welcome!** - diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 97131045..00000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,27 +0,0 @@ - - - - -These changes partially address #xxxx -These changes close #xxxx -This is a small change with no associated Issue. - - - - -## Requirements check-list - -- [ ] I have read `CONTRIBUTING.md` and added my name as a Code Contributor. -- [ ] Contains logically grouped changes (else tidy your branch by rebase). -- [ ] Does not contain off-topic changes (use other PRs for other changes). -- [ ] Applied any dependency changes to `setup.cfg`. - -- [ ] Appropriate tests are included (unit and/or functional). -- [ ] Already covered by existing tests. -- [ ] Does not need tests (why?). - -- [ ] Appropriate change log entry included. -- [ ] No change log entry required (why? e.g. invisible to users). - -- [ ] I have updated the documentation in this PR branch. -- [ ] No documentation update required. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4461cf27..c4f5b82f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,28 +1,35 @@ -# Cylc: How to Contribute +# Cylc Rose: 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 into *master*. +**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 `1.0.x` milestone, branch off of `1.0.x` to +develop your bugfix, then raise the pull request against the `1.0.x` branch. +We will later merge the `1.0.x` branch into `master`. + +Feel free to ask questions on the issue or developers chat if unsure about anything. + ## Code Contributors