It is warmly welcomed if you have interest to hack on PouchContainer. First, we encourage this kind of willing very much. And here is a list of contributing guide for you.
- Reporting security issues
- Reporting general issues
- Code and doc contribution
- Test case contribution
- Engage to help anything
Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of PouchContainer, please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to [email protected] to report this.
To be honest, we regard every user of PouchContainer as a very kind contributor. After experiencing PouchContainer, you may have some feedback for the project. Then feel free to open an issue via NEW ISSUE.
Since we collaborate project PouchContainer in a distributed way, we appreciate WELL-WRITTEN, DETAILED, EXPLICIT issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one.
To make the issue details as standard as possible, we setup an ISSUE TEMPLATE for issue reporters. Please BE SURE to follow the instructions to fill fields in template.
There are a lot of cases when you could open an issue:
- bug report
- feature request
- performance issues
- feature proposal
- feature design
- help wanted
- doc incomplete
- test improvement
- any questions on project
- and so on
Also we must remind that when filling a new issue, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on.
Every action to make project PouchContainer better is encouraged. On GitHub, every improvement for PouchContainer could be via a PR (short for pull request).
- If you find a typo, try to fix it!
- If you find a bug, try to fix it!
- If you find some redundant codes, try to remove them!
- If you find some test cases missing, try to add them!
- If you could enhance a feature, please DO NOT hesitate!
- If you find code implicit, try to add comments to make it clear!
- If you find code ugly, try to refactor that!
- If you can help to improve documents, it could not be better!
- If you find document incorrect, just do it and fix that!
- ...
Actually it is impossible to list them completely. Just remember one principle:
WE ARE LOOKING FORWARD TO ANY PR FROM YOU.
Since you are ready to improve PouchContainer with a PR, we suggest you could take a look at the PR rules here.
To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps:
-
FORK PouchContainer to your repository. To make this work, you just need to click the button Fork in right-left of alibaba/pouch main page. Then you will end up with your repository in
https://github.com/<your-username>/pouch, in whichyour-usernameis your GitHub username. -
CLONE your own repository to develop locally. Use
git clone https://github.com/<your-username>/pouch.gitto clone repository to your local machine. Then you can create new branches to finish the change you wish to make. -
Set Remote upstream to be
https://github.com/alibaba/pouch.gitusing the following two commands:
git remote add upstream https://github.com/alibaba/pouch.git
git remote set-url --push upstream no-pushing
With this remote setting, you can check your git remote configuration like this:
$ git remote -v
origin https://github.com/<your-username>/pouch.git (fetch)
origin https://github.com/<your-username>/pouch.git (push)
upstream https://github.com/alibaba/pouch.git (fetch)
upstream no-pushing (push)
Adding this, we can easily synchronize local branches with upstream branches.
Right now we assume every contribution via pull request is for branch master in PouchContainer. Before contributing, be aware of branch definition would help a lot.
As a contributor, keep in mind again that every contribution via pull request is for branch master. While in project PouchContainer, there are several other branches, we generally call them rc (release candidate) branches, release branches and backport branches.
Before officially releasing a version, we will checkout a rc branch. In this branch, we will test more than branch master, and will cherry-pick some new severe fix commits to this branch.
When officially releasing a version, there will be a release branch before tagging. After tagging, we will delete the release branch.
When backporting some fixes to existing released version, we will checkout backport branches. After backporting, the backporting effects will be in PATCH number in MAJOR.MINOR.PATCH of SemVer.
Actually in PouchContainer, we take three rules serious when committing:
Commit message could help reviewers better understand what is the purpose of submitted PR. It could help accelerate the code review procedure as well. We encourage contributors to use EXPLICIT commit message rather than ambiguous message. In general, we advocate the following commit message type:
- docs: xxxx. For example, "docs: add docs about storage installation".
- feature: xxxx.For example, "feature: make result show in sorted order".
- bugfix: xxxx. For example, "bugfix: fix panic when input nil parameter".
- refactor: xxxx. For example, "refactor: simplify to make codes more readable".
- test: xxx. For example, "test: add unit test case for func InsertIntoArray".
- other readable and explicit expression ways.
On the other side, we discourage contributors from committing message like the following ways:
fix bugupdateadd doc
If you get lost, please see How to Write a Git Commit Message for a start.
Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help. In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are two minor rules for us to keep in mind:
- avoid very large change in a commit;
- complete and reviewable for each commit.
In addition, in the code change part, we suggest that all contributors should read the code style of PouchContainer.
No matter commit message, or commit content, we do take more emphasis on code review.
The sign-off is a simple line at the end of the explanation for the patch, which certifies that you wrote it or otherwise have the right to pass it on as an open-source patch. The rules are pretty simple: if you can certify the below (from developercertificate.org):
Developer Certificate of Origin
Version 1.1
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
660 York Street, Suite 102,
San Francisco, CA 94110 USA
Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Then you just add a line to every git commit message:
Signed-off-by: Joe Smith <[email protected]>
Use your real name (sorry, no pseudonyms or anonymous contributions.)
If you set your user.name and user.email git configs, you can sign your commit automatically with git commit -s.
PR is the only way to make change to PouchContainer project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the PR template to finish the pull request.
Any test case would be welcomed. Currently, PouchContainer function test cases are high priority.
- For unit test, you need to create a test file ended with
_test.goin the same directory as dev package. - For integration test, you need to add test scrips in
pouch/test/directory. The test makes use of package check, a rich testing extension for Go's testing package. Test scripts are named by pouch commands. For example, all PouchContainer help api tests are included in pouch_api_help_test.go and all PouchContainer help command line tests are included in pouch_cli_help_test.go. For more details, please refer to gocheck document.
We choose GitHub as the primary place for PouchContainer to collaborate. So the latest updates of PouchContainer are always here. Although contributions via PR is an explicit way to help, we still call for any other ways.
- reply to other's issues if you could;
- help solve other user's problems;
- help review other's PR design;
- help review other's codes in PR;
- discuss about PouchContainer to make things clearer;
- advocate PouchContainer technology beyond GitHub;
- write blogs on PouchContainer and so on.
In a word, ANY HELP IS CONTRIBUTION.