From 610c2708ca2f4128dd101065adddba490064bef7 Mon Sep 17 00:00:00 2001 From: tobi <31960611+tsmethurst@users.noreply.github.com> Date: Fri, 9 Dec 2022 11:53:58 +0100 Subject: [docs] Update `CONTRIBUTING.md`, add pull request templates (#1216) * [docs] Update contributing.md - Add Pull Request process and guidelines. - Add feature/bug issue process. - Rearrange some sections for clarity. - Add overview of package structure. * [docs] Add build from source links * [chore] add pull request templates These link to the new CONTRIBUTING.md document, and include a checklist to validate that contributors have read the guidelines. * [docs] Put existing stub CoC in separate doc * update web related stuff in CONTRIBUTING.md Co-authored-by: f0x --- .github/PULL_REQUEST_TEMPLATE/feature.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 .github/PULL_REQUEST_TEMPLATE/feature.md (limited to '.github/PULL_REQUEST_TEMPLATE/feature.md') diff --git a/.github/PULL_REQUEST_TEMPLATE/feature.md b/.github/PULL_REQUEST_TEMPLATE/feature.md new file mode 100644 index 000000000..63f497980 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/feature.md @@ -0,0 +1,16 @@ +# Description + +> Please include a summary of the feature you've coded, and link to the issue that it closes/implements. + +Implements # (issue) + +# Checklist: + +- [ ] I have read the [GoToSocial contribution guidelines](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md). +- [ ] I have discussed my implementation already, either in an issue on the repository, or in the Matrix chat. +- [ ] I have performed a self-review of my own code. +- [ ] I have commented my code, particularly in hard-to-understand areas. +- [ ] I have made any necessary changes to documentation. +- [ ] New and existing tests pass locally with my changes. +- [ ] I have run `go fmt ./...` and `golangci-lint run`. +- [ ] I have added tests that cover my new code. -- cgit v1.3