Skip to content

Commit

Permalink
Update community docs (#21)
Browse files Browse the repository at this point in the history
  • Loading branch information
LastTalon authored Jan 9, 2024
1 parent 080b8d4 commit 00b975d
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 12 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
name: Feature request
about: Suggest an idea for this project
title: ""
labels: enhancement
labels: feature
assignees: ""
---

## Problem

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

Expand Down
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement_suggestion.md
Original file line number Diff line number Diff line change
@@ -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.
4 changes: 2 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 7 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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

0 comments on commit 00b975d

Please sign in to comment.