summaryrefslogtreecommitdiffstats
path: root/.github
diff options
context:
space:
mode:
authorClementTsang <cjhtsang@uwaterloo.ca>2020-02-25 20:17:49 -0500
committerClementTsang <cjhtsang@uwaterloo.ca>2020-02-25 20:17:49 -0500
commit24025df1066edc663502a8273d784fd1aabb3162 (patch)
tree5836cf79b2557deafb64a76a211207a57251b04e /.github
parent039965f2eb86931ce75e38dd8899acf805dd63c6 (diff)
[skip travis] Update some github documentation.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE/bug_report.md12
-rw-r--r--.github/ISSUE_TEMPLATE/feature_request.md4
-rw-r--r--.github/pull_request_template.md16
-rw-r--r--.github/release_checklist.md63
4 files changed, 80 insertions, 15 deletions
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 7c6d8840..bdde99b4 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,22 +8,22 @@ assignees: "ClementTsang"
## Describe the bug
-A clear and concise description of what the bug is and what the expected behaviour was.
+_A clear and concise description of what the bug is and what the expected behaviour was:_
## To reproduce
-Steps on how to reproduce the behaviour:
+_Steps on how to reproduce the behaviour:_
-1. Go to ...
+1. Go to...
2. See error
## Screenshots
-If applicable, add screenshots to help explain your problem.
+_If applicable, add screenshots to help explain your problem:_
## Platform
-Provide information on:
+_Provide information on:_
**Operating System:**
@@ -33,4 +33,4 @@ Provide information on:
## Additional context
-If anything hasn't been covered by the above categories, state it down here.
+_If anything hasn't been covered by the above categories, state it down here:_
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index e2ce631e..45b18a2f 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,8 +8,8 @@ assignees: "ClementTsang"
## Describe the feature request
-Why should we consider this feature request? Describe why, and/or how you think this feature will solve the issue, or overall improve the application.
+_Why should we consider this feature request? Describe why, and/or how you think this feature will solve the issue, or overall improve the application:_
## Additional context/details
-Provide any additional context or details here. What needs to be done, why, etc.
+_Provide any additional context or details here. What needs to be done, why, etc:_
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index c94779b0..7828beab 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,26 +1,28 @@
## Description
-A description of the change and what it does. If relevant, please provide screenshots of what results from the change.
+_A description of the change and what it does. If relevant, please provide screenshots of what results from the change:_
## Issue
If applicable, what issue does this address?
-Issue:
+Issue: #
## Type of change
-Remove the irrelevant one.
+_Remove the irrelevant one:_
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
+- [x] Bug fix (non-breaking change which fixes an issue)
+- [x] New feature (non-breaking change which adds functionality)
## Test methodology
-Please state how this was tested.
+_Please state how this was tested:_
## Checklist
+_Please ensure all are ticked (and actually done):_
+
- [ ] Code has been linted
- [ ] Code has been self-reviewed
- [ ] Code has been tested and no new breakage is introduced
@@ -28,4 +30,4 @@ Please state how this was tested.
## Other information
-Provide any other relevant information.
+_Provide any other relevant information:_
diff --git a/.github/release_checklist.md b/.github/release_checklist.md
new file mode 100644
index 00000000..8be349b0
--- /dev/null
+++ b/.github/release_checklist.md
@@ -0,0 +1,63 @@
+# Release checklist
+
+This checklist is mostly for me personally - just want to have a easy to refer to record for what I should do before I release.
+
+## General
+
+- Did travis pass (obviously)?
+
+- Did you uptick the version?
+
+- Is every feature tested?
+
+- Are any new bugs introduced in the core features?
+
+- Did you test:
+
+ - Searching
+
+ - Do the modifiers work?
+
+ - Do all chars work?
+
+ - Basic widget movement
+
+ - Flags
+
+ - Config files
+
+ - Colouring
+
+- Did you _really_ test all this?
+
+- Did you test `cargo install` (I don't want to ever have to deal with that fiasco again, jeez)?
+
+- Is documentation up to spec?
+
+## Linux
+
+### Arch
+
+- Did you edit the PKGBUILD with the correct version + hash?
+
+- Did you add a .SRCINFO?
+
+- Did you test it?
+
+- Did you commit it all?
+
+### Debian
+
+- Did you edit the new `.deb` file version in?
+
+## macOS
+
+- Did you update the `bottom.rb` file with the correct version + hash?
+
+- Did you test it?
+
+## Windows
+
+- Did you edit the nupkg?
+
+- Did you test if it works?