Skip to content

Commit 2c96336

Browse files
douglowedouglowe
authored
Merge pull request #122 from UoMResearchIT/carpentry_workflow_update
Workflows Update
2 parents 694ee06 + 2cc056d commit 2c96336

12 files changed

Lines changed: 464 additions & 129 deletions

‎.github/ISSUE_TEMPLATE/bug.yml‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
name: Bug Report
2+
description: Report something not working with the project's code.
3+
type: Bug
4+
labels: [bug]
5+
# See https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for helping us by reporting a bug issue!
11+
Help us help you get things fixed.
12+
- type: textarea
13+
id: what-happened
14+
attributes:
15+
label: What happened?
16+
description: Also, what did you expect to happen?
17+
placeholder: Tell us what you see!
18+
validations:
19+
required: true
20+
- type: input
21+
id: version
22+
attributes:
23+
label: What version of our software are you running?
24+
placeholder: "I don't know..."
25+
description: >
26+
It can really help if you let us know what version of our software you are using.
27+
Sometimes the fix to the bug has already been implemented and all that is needed is an update, but this will let us know for sure.
28+
- type: textarea
29+
id: environment
30+
attributes:
31+
label: Where were you running our software?
32+
description: >
33+
Operating system, browser, shell, anything to help us know what environment our software is (not) working within.
34+
Sometimes, this is vital.
35+
- type: textarea
36+
id: logs
37+
attributes:
38+
label: Relevant log output
39+
description: >
40+
Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks.
41+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Security Problems
4+
url: https://www.itservices.manchester.ac.uk/help/connect/
5+
about: Security problems should be reported via Connect.

‎.github/ISSUE_TEMPLATE/feature.yml‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Feature Request
2+
description: >
3+
A request for a new feature to be added, for the software to do something that it did not previously do. Typically will take the form of a "User Story" and hence assumes that issue type.
4+
type: Feature
5+
labels: ["user story"]
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: >
10+
Thank you for making a suggestion of something new we should do.
11+
Usually, the more detail you can provide about what you think we should do, the easier it is to implement.
12+
- type: textarea
13+
id: requested-feature
14+
attributes:
15+
label: What are you asking for
16+
description: >
17+
Please describe what it is you want.
18+
placeholder: More information usually helps here.
19+
validations:
20+
required: true
21+
- type: input
22+
id: version
23+
attributes:
24+
label: What version of our software are you running?
25+
placeholder: "I don't know..."
26+
description: >
27+
It can really help if you let us know what version of our software you are using.
28+
Sometimes, features may already exist in later versions and all that is needed is an update, but this will let us know for sure.

‎.github/ISSUE_TEMPLATE/task.yml‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: New Task
2+
description: A request for something to be done that isn't really a bug fix or a new feature.
3+
type: Task
4+
labels: ["task"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: >
9+
We know not all things to do with a repository are clearly bug fixes or new features.
10+
Life isn't that simple.
11+
If you need to ask for anything else, this is for you.
12+
- type: textarea
13+
id: task
14+
attributes:
15+
label: What do you want us to do?
16+
description: >
17+
What is this task to be about?
18+
Please provide us with as much information as you think is relevant.
19+
placeholder: >
20+
I would like you to hop on one foot and let slip the doves of peace!
21+
validations:
22+
required: true

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
---
2+
name: Pull Request
3+
about: For submitting a code change.
4+
---
5+
6+
<!--
7+
Hi there!
8+
9+
Thanks for helping to contribute to this repository.
10+
Your contribution is very much appreciated.
11+
12+
Donal Fellows (@dkfellows) on behalf of University of Manchester Research Software Engineering.
13+
-->
14+
15+
<!--
16+
Here's a few things to think about when writing a PR; feel free to edit things around.
17+
-->
18+
19+
## Issue Description
20+
21+
<!-- These are things to put in the main description of the PR. Also pick a pithy title! -->
22+
23+
### What Issue does this PR fix?
24+
Is this fixing an issue? If so, please `#ref` its ID. This helps a lot!
25+
<!-- An issue is not required for submitting a PR, but it is strongly encouraged for all but the most trivial of fixes (like a spelling mistake in the README). -->
26+
27+
For extra magic, write that reference as this sentence: `This fixes #ref.` or this `Closes #ref.`
28+
This causes the PR to _automatically_ close the referenced issue when merged.
29+
30+
### What does this PR do?
31+
What do you think this PR does? We can see what it _actually_ does by reading the code,
32+
but it's very helpful to have a short description of what you _intend_ it to do.
33+
34+
### Do you know who could review this PR?
35+
Don't forget to Request a Review from a team member when this PR is ready.
36+
<!-- If you know it's going to take quite a bit more work before it is ready for review, consider making this a Draft PR instead, via the dropdown on the Submit button. -->
37+
38+
## Standard Review Checklist for _Authors_
39+
<!-- These do not all apply to every PR, and some are easy YESes. You don't have to get everything on the list ticked off, but it's a very good starting point for a top-quality feature change. -->
40+
<!-- If you can change these checklist items to be something checked automatically instead of manually, so much the better. If you've got that working, you might be able to remove them from the checklist and make them Required workflow checks instead. -->
41+
- [ ] Does the code change do what it is claimed to do? <!-- Keeping PRs small makes this easier. -->
42+
- [ ] Is the code change able to be built? <!-- Whatever that means for the particular case. -->
43+
- [ ] Is the code change tested? <!-- Testing is a complex topic... -->
44+
- [ ] Is the code change documented? <!-- Particularly important for API changes. -->
45+
- [ ] Does the code change follow the repository's style guide, if there is one? <!-- Internal consistency aids readability and reviewability. -->
46+
<!-- Adding more items to this checklist is fine, but it adds friction for both developing and reviewing. -->
47+
48+
The [RSE handbook](https://livemanchesterac.sharepoint.com/:b:/r/sites/UOM-ITS-Research-IT/Shared%20Documents/RSE%20Team/Read-Only/Policies%20and%20Processes/RSE_Agile_Methods_Handbook.pdf?csf=1&web=1&e=CNE4Nm) has further guidance to reviewers.

‎.github/workbench-docker-version.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
v0.2.8

0 commit comments

Comments
 (0)