docs: expand issue contribution guidance
This commit is contained in:
+37
-11
@@ -2,7 +2,8 @@
|
|||||||
|
|
||||||
Thanks for your interest in restic-manager. This document covers how
|
Thanks for your interest in restic-manager. This document covers how
|
||||||
to set up a development environment, the conventions the project
|
to set up a development environment, the conventions the project
|
||||||
follows, and how patches make it from your machine into `main`.
|
follows, and how to contribute through issues as well as patches that
|
||||||
|
make it from your machine into `main`.
|
||||||
|
|
||||||
## Project status and scope
|
## Project status and scope
|
||||||
|
|
||||||
@@ -108,6 +109,32 @@ admin user.
|
|||||||
|
|
||||||
## Workflow
|
## Workflow
|
||||||
|
|
||||||
|
### Opening an issue
|
||||||
|
|
||||||
|
Issues are contributions too. Use them to report a bug, suggest a
|
||||||
|
feature, improve the documentation, or start a design discussion even
|
||||||
|
if you do not plan to submit a patch.
|
||||||
|
|
||||||
|
Before opening one, search the existing issues and check `tasks.md` to
|
||||||
|
see whether the topic is already tracked. Then choose the closest issue
|
||||||
|
template:
|
||||||
|
|
||||||
|
- [Bug report](./.gitea/issue_template/bug_report.md) for behaviour that
|
||||||
|
does not match the documentation or expected operation.
|
||||||
|
- [Feature request](./.gitea/issue_template/feature_request.md) for a new
|
||||||
|
capability or a change to existing behaviour.
|
||||||
|
|
||||||
|
Give the issue a specific title, keep it to one problem or proposal,
|
||||||
|
and complete the relevant template fields. If no template is an exact
|
||||||
|
fit, open a regular issue and explain the context, desired outcome, and
|
||||||
|
any alternatives you have considered. Maintainers may ask follow-up
|
||||||
|
questions or close requests that duplicate existing work or fall
|
||||||
|
outside the project's scope.
|
||||||
|
|
||||||
|
Security-sensitive reports are the exception: follow the
|
||||||
|
[SECURITY.md](./SECURITY.md) disclosure process and do not open a public
|
||||||
|
issue.
|
||||||
|
|
||||||
### Before opening a PR
|
### Before opening a PR
|
||||||
|
|
||||||
1. **Open an issue first** for non-trivial changes. The design is
|
1. **Open an issue first** for non-trivial changes. The design is
|
||||||
@@ -136,25 +163,24 @@ The PR template asks for:
|
|||||||
|
|
||||||
### Reporting bugs
|
### Reporting bugs
|
||||||
|
|
||||||
Open an issue with:
|
Use the bug report issue template and include:
|
||||||
|
|
||||||
- restic-manager version (`server --version`) and agent version.
|
- restic-manager version (`server --version`) and agent version.
|
||||||
- restic version on the affected host.
|
- restic version on the affected host.
|
||||||
- Steps to reproduce.
|
- Steps to reproduce.
|
||||||
- Server and agent logs (sanitise any tokens before pasting).
|
- Server and agent logs (sanitise any tokens before pasting).
|
||||||
|
|
||||||
Security-sensitive bugs go through the [SECURITY.md](./SECURITY.md)
|
For security-sensitive bugs, use the private disclosure process noted
|
||||||
disclosure path instead — please don't open a public issue for
|
above.
|
||||||
them.
|
|
||||||
|
|
||||||
### Suggesting features
|
### Suggesting features
|
||||||
|
|
||||||
Open an issue describing the use case (not just the proposed
|
Use the feature request issue template and describe the use case (not
|
||||||
solution). The roadmap in `tasks.md` shows where the project is
|
just the proposed solution). The roadmap in `tasks.md` shows where the
|
||||||
heading; if the suggestion fits a future phase we'll wire it in
|
project is heading; if the suggestion fits a future phase we'll wire it
|
||||||
there. If it falls outside the project's scope (multi-tenancy, SaaS,
|
in there. If it falls outside the project's scope (multi-tenancy, SaaS,
|
||||||
non-restic backends — see `spec.md` §2 non-goals) we'll say so
|
non-restic backends — see `spec.md` §2 non-goals) we'll say so early to
|
||||||
early to save your time.
|
save your time.
|
||||||
|
|
||||||
## Code of conduct
|
## Code of conduct
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user