Skip to content
This repository was archived by the owner on Jul 26, 2022. It is now read-only.

Commit da09d37

Browse files
author
Silas Boyd-Wickizer
authored
docs: add _some_ details to CONTRIBUTING.md (#500)
1 parent 720e33b commit da09d37

File tree

1 file changed

+39
-3
lines changed

1 file changed

+39
-3
lines changed

CONTRIBUTING.md

+39-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,43 @@
22

33
Thanks for taking the time to contribute!
44

5-
## Publishing a new release
5+
## Contributing an Issue
66

7-
If you're a maintainer use `npm run release` to start the release
8-
process and follow the instructions printed to the console.
7+
We will try to respond to every issue. The issues that get the
8+
quickest response are the ones that are easiest to respond to. The
9+
issues that are easiest to respond to usually include the
10+
following:
11+
12+
* For unexpected behavior or bugs, include sufficient details about
13+
your cluster and workload so that other contributors can try to
14+
reproduce the issue.
15+
* For requests for help, explain what outcome you're trying to achieve
16+
(*e.g.*, "access secret data in AWS Secret Manager from a `Pod`")
17+
in addition to how you're trying to achieve it (*e.g.*, "I installed
18+
the Helm Chart on my cluster with these options and created an
19+
`ExternalSecret`").
20+
* Relevant logs (*e.g.*, warnings and errors) from the external
21+
secrets controller.
22+
* For feature requests, a description of the impact the feature will
23+
have on your project or cluster management experience. If possible,
24+
include a link to the open source repository for your project.
25+
26+
## Contributing a Pull Request
27+
28+
The most useful PRs provide the following:
29+
30+
1. Rationale for the PR. This can be a link to a supporting issue, or
31+
if it's a short PR a brief explanation in the PR.
32+
1. Changes that pass all testing (*i.e.*, your PR will not break
33+
main). See the Development section in the
34+
[README.md](./README.md#development) for more details.
35+
1. A small set of changes. It's OK to split up the full implementation
36+
of a large new feature over multiple PRs that each add a small bit
37+
of functionality.
38+
39+
## Maintainers
40+
41+
### Publishing a new release
42+
43+
Use `npm run release` to start the release process and follow the
44+
instructions printed to the console.

0 commit comments

Comments
 (0)