mirror of
https://github.com/restic/restic.git
synced 2026-11-21 13:02:42 +00:00
* Small typos and clarification in contributing guide * cross-link contributing guide and issue/pr template * drop GOPATH mention * don't include merge commits in PRs * make high review delays explicit * explicitly ask for link to current PR in changelog template * clarify docs changes * use bug template as authoritative place' * consolidate development information in 090_participating Also move issue / PR creation relevant information into contributing.md. * clarify meaning of assigning to a pull request * link to minimum go version * minor typos * golanci-lint is always applied in full * add micro summary * more typo fixes * always run golangci-lint * Simplify issue/pr template * Fix IRC webchat link * Move security policy to SECURITY.md * address review comments
34 lines
1.6 KiB
Plaintext
34 lines
1.6 KiB
Plaintext
# The first line must start with Bugfix:, Enhancement: or Change:,
|
|
# including the colon. 'Change:' is for breaking changes only.
|
|
# Documentation-only changes do not get a changelog entry.
|
|
# Include the affected command in the summary if relevant.
|
|
#
|
|
# Use present tense and the imperative mood. Remove lines starting
|
|
# with '#' from this template.
|
|
Enhancement: Allow custom bar in the `foo` command
|
|
|
|
# Describe the problem in the past tense, the new behavior in the present
|
|
# tense. Mention the affected commands, backends, operating systems, etc.
|
|
# If the problem description just says that a feature was missing, then
|
|
# only explain the new behavior. Aim for a short and concise description.
|
|
# Use "Restic now ..." instead of "We have changed ...".
|
|
#
|
|
# Focus on user-facing behavior, not the implementation. The description should
|
|
# be understandable for a regular user without knowledge of the implementation.
|
|
|
|
Restic foo always used the system-wide bar when deciding how to frob an
|
|
item in the `baz` backend. It now permits selecting the bar with `--bar`
|
|
or the environment variable `RESTIC_BAR`. The system-wide bar is still
|
|
the default.
|
|
|
|
# The last section is a list of issue, PR and forum URLs.
|
|
# The first issue ID determines the filename for the changelog entry:
|
|
# changelog/unreleased/issue-1234. If there are no relevant issue links,
|
|
# use the PR ID and call the file pull-55555.
|
|
#
|
|
# Make sure to always include a link to the PR that introduces the change.
|
|
|
|
https://github.com/restic/restic/issues/1234
|
|
https://github.com/restic/restic/pull/55555
|
|
https://forum.restic.net/foo/bar/baz
|