-
Notifications
You must be signed in to change notification settings - Fork 949
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: change pouch to PouchContainer (#1525)
update all docs and use PouchContainer word
- Loading branch information
1 parent
6cf387a
commit c1d3a46
Showing
32 changed files
with
287 additions
and
287 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,6 @@ | ||
| # Contributing to Pouch | ||
| # Contributing to PouchContainer | ||
|
|
||
| It is warmly welcomed if you have interest to hack on Pouch. First, we encourage this kind of willing very much. And here is a list of contributing guide for you. | ||
| 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. | ||
|
|
||
| ## Topics | ||
|
|
||
|
|
@@ -11,13 +11,13 @@ It is warmly welcomed if you have interest to hack on Pouch. First, we encourage | |
|
|
||
| ## Reporting security issues | ||
|
|
||
| Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Pouch, 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]](mailto:[email protected]) to report this. | ||
| 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]](mailto:[email protected]) to report this. | ||
|
|
||
| ## Reporting general issues | ||
|
|
||
| To be honest, we regard every user of Pouch as a very kind contributor. After experiencing Pouch, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/alibaba/pouch/issues/new). | ||
| 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](https://github.com/alibaba/pouch/issues/new). | ||
|
|
||
| Since we collaborate project Pouch 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. | ||
| 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](./.github/ISSUE_TEMPLATE.md) for issue reporters. Please **BE SURE** to follow the instructions to fill fields in template. | ||
|
|
||
|
|
@@ -38,7 +38,7 @@ Also we must remind that when filing a new issue, please remember to remove the | |
|
|
||
| ## Code and doc contribution | ||
|
|
||
| Every action to make project Pouch better is encouraged. On GitHub, every improvement for Pouch could be via a PR (short for pull request). | ||
| 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! | ||
|
|
@@ -55,7 +55,7 @@ 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 Pouch with a PR, we suggest you could take a look at the PR rules here. | ||
| Since you are ready to improve PouchContainer with a PR, we suggest you could take a look at the PR rules here. | ||
|
|
||
| * [Workspace Preparation](#workspace-preparation) | ||
| * [Branch Definition](#branch-definition) | ||
|
|
@@ -66,7 +66,7 @@ Since you are ready to improve Pouch with a PR, we suggest you could take a look | |
|
|
||
| To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps: | ||
|
|
||
| 1. **FORK** Pouch to your repository. To make this work, you just need to click the button Fork in right-left of [alibaba/pouch](https://github.com/alibaba/pouch) main page. Then you will end up with your repository in `https://github.com/<your-username>/pouch`, in which `your-username` is your GitHub username. | ||
| 1. **FORK** PouchContainer to your repository. To make this work, you just need to click the button Fork in right-left of [alibaba/pouch](https://github.com/alibaba/pouch) main page. Then you will end up with your repository in `https://github.com/<your-username>/pouch`, in which `your-username` is your GitHub username. | ||
|
|
||
| 1. **CLONE** your own repository to develop locally. Use `git clone https://github.com/<your-username>/pouch.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make. | ||
|
|
||
|
|
@@ -91,9 +91,9 @@ Adding this, we can easily synchronize local branches with upstream branches. | |
|
|
||
| ### Branch Definition | ||
|
|
||
| Right now we assume every contribution via pull request is for [branch master](https://github.com/alibaba/pouch/tree/master) in Pouch. Before contributing, be aware of branch definition would help a lot. | ||
| Right now we assume every contribution via pull request is for [branch master](https://github.com/alibaba/pouch/tree/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 pouch, there are several other branches, we generally call them rc branches, release branches and backport branches. | ||
| 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 branches, release branches and backport branches. | ||
|
|
||
| Before officially releasing a version, we will checkout a rc(release candidate) branch. In this branch, we will test more than branch master, and will [cherry-pick](https://git-scm.com/docs/git-cherry-pick) some new severe fix commits to this branch. | ||
|
|
||
|
|
@@ -103,7 +103,7 @@ When backporting some fixes to existing released version, we will checkout backp | |
|
|
||
| ### Commit Rules | ||
|
|
||
| Actually in Pouch, we take two rules serious when committing: | ||
| Actually in PouchContainer, we take two rules serious when committing: | ||
|
|
||
| * [Commit Message](#commit-message) | ||
| * [Commit Content](#commit-content) | ||
|
|
@@ -132,31 +132,31 @@ Commit content represents all content changes included in one commit. We had bet | |
| * 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 Pouch](docs/contributions/code_styles.md). | ||
| In addition, in the code change part, we suggest that all contributors should read the [code style of PouchContainer](docs/contributions/code_styles.md). | ||
|
|
||
| No matter commit message, or commit content, we do take more emphasis on code review. | ||
|
|
||
| ### PR Description | ||
|
|
||
| PR is the only way to make change to Pouch project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](./.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request. | ||
| 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](./.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request. | ||
|
|
||
| ### Test case contribution | ||
|
|
||
| Any test case would be welcomed. Currently, pouch function test cases are high priority. | ||
| 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.go` in 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](https://github.com/go-check/check), a rich testing extension for Go's testing package. Test scripts are named by pouch commands. For example, all pouch help api tests are included in pouch_api_help_test.go and all pouch help command line tests are included in pouch_cli_help_test.go. For more details, please refer to [gocheck document](https://godoc.org/gopkg.in/check.v1). | ||
| * For integration test, you need to add test scrips in `pouch/test/` directory. The test makes use of [package check](https://github.com/go-check/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](https://godoc.org/gopkg.in/check.v1). | ||
|
|
||
| ## Engage to help anything | ||
|
|
||
| We choose GitHub as the primary place for Pouch to collaborate. So the latest updates of Pouch are always here. Although contributions via PR is an explicit way to help, we still call for any other ways. | ||
| 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 Pouch to make things clearer; | ||
| * advocate Pouch technology beyond GitHub; | ||
| * write blogs on Pouch and so on. | ||
| * 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.** | ||
Oops, something went wrong.