From 5592ebae7db31096e6116965b4dcd664d6933824 Mon Sep 17 00:00:00 2001 From: SquidDev Date: Thu, 30 May 2019 08:33:55 +0100 Subject: [PATCH] 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. --- .github/ISSUE_TEMPLATE/feature_request.md | 2 +- .github/pull_request_template.md | 3 +++ README.md | 9 +++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 66d6539e0..e3ab2ee46 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -11,4 +11,4 @@ ## Before reporting ## 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?". diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 000000000..00d021014 --- /dev/null +++ b/.github/pull_request_template.md @@ -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`. diff --git a/README.md b/README.md index ab2cb561f..2f41e7da7 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,15 @@ ## Contributing If you want to run CC:T in a normal Minecraft instance, run `./gradlew build` and copy the `.jar` from `build/libs`. +## Community +If you need help getting started with CC: Tweaked, want to show off your latest project, or just want to chat about +ComputerCraft we have a [forum](https://forums.computercraft.cc/) and [Discord guild](https://discord.gg/H2UyJXe)! +There's also a fairly populated, albeit quiet [IRC channel](http://webchat.esper.net/?channels=#computercraft), if +that's more your cup of tea. + +I'd generally recommend you don't contact me directly (email, DM, etc...) unless absolutely necessary (i.e. in order to +report exploits). You'll get a far quicker response if you ask the whole community! + ## Using If you want to depend on CC:Tweaked, we have a maven repo. However, you should be wary that some functionality is only exposed by CC:T's API and not vanilla ComputerCraft. If you wish to support all variations of ComputerCraft, I recommend