[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 <f0x@cthu.lu>
This commit is contained in:
tobi 2022-12-09 11:53:58 +01:00 committed by GitHub
commit 610c2708ca
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
7 changed files with 412 additions and 241 deletions

15
.github/PULL_REQUEST_TEMPLATE/bugfix.md vendored Normal file
View file

@ -0,0 +1,15 @@
# Description
> Please include a summary of the change and which issue is fixed.
Fixes # (issue)
# Checklist:
- [ ] I have read the [GoToSocial contribution guidelines](https://github.com/superseriousbusiness/gotosocial/blob/main/CONTRIBUTING.md).
- [ ] 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 prove my fix is effective.

View file

@ -0,0 +1,3 @@
# Description
> Please briefly explain the documentation change that you've made, and why.

View file

@ -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.