mirror of
https://github.com/ClementTsang/bottom
synced 2025-02-16 21:28:26 +00:00
[skip travis] Update some github documentation.
This commit is contained in:
parent
039965f2eb
commit
24025df106
4 changed files with 80 additions and 15 deletions
12
.github/ISSUE_TEMPLATE/bug_report.md
vendored
12
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -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:_
|
||||
|
|
4
.github/ISSUE_TEMPLATE/feature_request.md
vendored
4
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -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:_
|
||||
|
|
16
.github/pull_request_template.md
vendored
16
.github/pull_request_template.md
vendored
|
@ -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:_
|
||||
|
|
63
.github/release_checklist.md
vendored
Normal file
63
.github/release_checklist.md
vendored
Normal file
|
@ -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?
|
Loading…
Add table
Reference in a new issue