From 00b975d901eab55a5bc44f4589ae1a8c76c3de18 Mon Sep 17 00:00:00 2001 From: Lucas Gangstad Date: Mon, 8 Jan 2024 18:07:46 -0600 Subject: [PATCH] Update community docs (#21) --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- .github/ISSUE_TEMPLATE/feature_request.md | 4 ++-- .../ISSUE_TEMPLATE/improvement_suggestion.md | 22 +++++++++++++++++++ .github/PULL_REQUEST_TEMPLATE.md | 4 ++-- CHANGELOG.md | 4 ++-- CONTRIBUTING.md | 12 +++++----- 6 files changed, 36 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/improvement_suggestion.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index bcd569e..cf10e38 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -9,7 +9,7 @@ assignees: "" ## Description A clear and concise description of what the bug is. Be sure this isn't a -[duplicate report](https://github.com/LastTalon/matter-hooks/issues) (if it is, +[duplicate report](https://github.com/matter-ecs/matter-hooks/issues) (if it is, contribute to the already opened bug report). ## Steps to reproduce diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index cc1a256..8cd77e0 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -2,7 +2,7 @@ name: Feature request about: Suggest an idea for this project title: "" -labels: enhancement +labels: feature assignees: "" --- @@ -10,7 +10,7 @@ assignees: "" A clear and concise description of what the problem is or what you would like to do differently. If there is a related -[issue](https://github.com/LastTalon/matter-hooks/issues), let us know here. +[issue](https://github.com/matter-ecs/matter-hooks/issues), let us know here. ## Proposed solution diff --git a/.github/ISSUE_TEMPLATE/improvement_suggestion.md b/.github/ISSUE_TEMPLATE/improvement_suggestion.md new file mode 100644 index 0000000..04889b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement_suggestion.md @@ -0,0 +1,22 @@ +--- +name: Improvement suggestion +about: A minor enhancement or quality of life improvement +title: "" +labels: improvement +assignees: "" +--- + +## Current behavior + +A clear and concise description of the current behavior, and why you think it +can be enhanced. If there is a related +[issue](https://github.com/matter-ecs/matter-hooks/issues), let us know here. + +## Proposed improvement + +A clear and concise description of what you want to happen. + +## Additional context + +Provide any additional context or examples that can help us understand the +importance of this improvement. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 032fadb..29975ea 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,12 +2,12 @@ A clear and concise description of what your changes are. Explain to maintainers why we should accept your solution. Be sure to adhere to our -[contribution guidelines](https://github.com/LastTalon/matter-hooks/blob/main/CONTRIBUTING.md). +[contribution guidelines](https://github.com/matter-ecs/matter-hooks/blob/main/CONTRIBUTING.md). ## Related issues Explain how this pull request relates to any relevant -[issues](https://github.com/LastTalon/matter-hooks/issues). Bugs and features +[issues](https://github.com/matter-ecs/matter-hooks/issues). Bugs and features should always have related issues. ## Additional comments diff --git a/CHANGELOG.md b/CHANGELOG.md index fcfb9c0..ac47d25 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,5 +28,5 @@ The format is based on [Keep a Changelog][kac], and this project adheres to for a provided streaming ID attribute, and optionally, its descendants as they stream. -[unreleased]: https://github.com/LastTalon/matter-hooks/compare/v0.1.0...HEAD -[0.1.0]: https://github.com/LastTalon/matter-hooks/releases/tag/v0.1.0 +[unreleased]: https://github.com/matter-ecs/matter-hooks/compare/v0.1.0...HEAD +[0.1.0]: https://github.com/matter-ecs/matter-hooks/releases/tag/v0.1.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 97ac831..298c1c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,12 +53,14 @@ Great! ### Did you fix something purely cosmetic in the codebase? We appreciate your enthusiasm, however cosmetic code patches are unlikely to be -approved. We do care about code quality, but the cost of reviewing it typically -outweighs the benefit of the change. +approved. We do care about code quality, but the [cost] typically outweighs the +benefit of the change. + +[cost]: https://github.com/rails/rails/pull/13771#issuecomment-32746700 ## Releases -Releases for Sentinel are made by a maintainer using a release branch and a +Releases for Matter Hooks are made by a maintainer using a release branch and a pull request. 1. Create a new release branch @@ -67,9 +69,9 @@ pull request. 4. Create a pull request against `main` 5. Review to ensure a stable release 6. Make any necessary changes (be sure to keep `CHANGELOG.md` accurate) -7. Rebase and merge the pull request +7. Squash and merge the pull request 8. Push a new version tag 9. Write GitHub release notes [semver]: https://semver.org/ -[issue]: https://github.com/LastTalon/matter-hooks/issues +[issue]: https://github.com/matter-ecs/matter-hooks/issues