Skip to content

Commit 2f4dd55

Browse files
committed
docs: Add CONTRIBUTING
1 parent 48ec12f commit 2f4dd55

File tree

1 file changed

+31
-0
lines changed

1 file changed

+31
-0
lines changed

CONTRIBUTING.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Contributing to Storage
2+
3+
+1tada First off, thanks for taking the time to contribute! tada+1
4+
5+
## Did you find a bug?
6+
7+
- Ensure the bug was not already reported by searching on GitHub under [Issues](https://github.com/Xuanwo/storage/issues).
8+
- Open a new issue with following things:
9+
- bug description
10+
- lib commit id
11+
- minimal reproduction code
12+
13+
## Did you write a patch that fixes a bug?
14+
15+
- Open a new GitHub pull request with the patch.
16+
- Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
17+
- Add unittest for this bug.
18+
19+
## Do you intend to implement a new service?
20+
21+
- `Storager` must be implemented, others can be optional.
22+
- Add support in `coreutils.Open`.
23+
- Add unittests as best effort.
24+
25+
## Do you intend to change public API?
26+
27+
- Open a new Github Issue for discuss.
28+
- After achieve consensus, add a proposal in `docs/design` and submit a PR.
29+
- Implement a proposal and change status to `candidate`
30+
31+
> In next release, relevant proposal statue will be updated to `finished`

0 commit comments

Comments
 (0)