mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-08-30 09:07:55 +00:00
A small bit of housekeeping
- Add a link to discord and the forums. Oh goodness, I hope this doesn't count as making things official. I've had a couple of people email me with support requests, which is /fine/, but there's better channels for it! - Add a couple of PR templates - Ask people to write tests for CraftOS changes. This is a standard I'm trying to impose on myself, so seems reasonable to impose on everyone. Sorry! - Require same levels of explanation for PRs as we do for issues. - Try to expand on the feature request "rationale" section a little. Just trying to explan my process a little bit more.
This commit is contained in:
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
@@ -11,4 +11,4 @@ labels: enhancement
|
||||
|
||||
## Useful information to include:
|
||||
- Explanation of how the feature/change should work.
|
||||
- Some rationale/use case for a feature. I'd like to keep CC:T as minimal as possible, so I like have a solid justification for each feature.
|
||||
- Some rationale/use case for a feature. My general approach to designing new features is to ask yourself "what issue are we trying to solve" and _then_ "is this the best way to solve this issue?".
|
||||
|
3
.github/pull_request_template.md
vendored
Normal file
3
.github/pull_request_template.md
vendored
Normal file
@@ -0,0 +1,3 @@
|
||||
## A quick checklist
|
||||
- If there's a existing issue, please link to it. If not, provide fill out the same information you would in a normal issue - reproduction steps for bugs, rationale for use-case.
|
||||
- If you're working on CraftOS, try to write a few test cases so we can ensure everything continues to work in the future. Tests live in `src/test/resources/test-rom/spec` and can be run with `./gradlew check`.
|
Reference in New Issue
Block a user