Minor contributing fixups
This is a follow-up of https://github.com/docker/distribution/pull/545 and makes some stylistic changes in the CONTRIBUTING document; - Replaces checkboxes with regular bullets. Because the checkboxes are read-only for non-contributors, they are presented as 'greyed out', which makes them harder to see (depending on the browser used) - Replaces bullets for numbered lists in the "creating an issue" and "contributing a patch" sections. The numbers make it easier for readers to track where they left off. - Cleans up some minor Markdown changes for consistency Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn
parent
4e1280405a
commit
7834db55fb
1 changed files with 49 additions and 48 deletions
|
|
@ -4,70 +4,71 @@
|
|||
|
||||
### If your problem is with...
|
||||
|
||||
- [ ] automated builds
|
||||
- [ ] your account on the [Docker Hub](https://hub.docker.com/)
|
||||
- [ ] any other [Docker Hub](https://hub.docker.com/) issue
|
||||
- automated builds
|
||||
- your account on the [Docker Hub](https://hub.docker.com/)
|
||||
- any other [Docker Hub](https://hub.docker.com/) issue
|
||||
|
||||
Then please do not report your issue here - you should instead report it to [https://support.docker.com]
|
||||
Then please do not report your issue here - you should instead report it to [https://support.docker.com](https://support.docker.com)
|
||||
|
||||
### If you...
|
||||
|
||||
- [ ] need help setting up your registry
|
||||
- [ ] can't figure out something
|
||||
- [ ] are not sure what's going on or what your problem is
|
||||
- need help setting up your registry
|
||||
- can't figure out something
|
||||
- are not sure what's going on or what your problem is
|
||||
|
||||
Then please do not open an issue here yet - you should first try one of the following support forums:
|
||||
|
||||
* irc: #docker-distribution on freenode
|
||||
* mailing-list: <distribution@dockerproject.org> or https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution
|
||||
- irc: #docker-distribution on freenode
|
||||
- mailing-list: <distribution@dockerproject.org> or https://groups.google.com/a/dockerproject.org/forum/#!forum/distribution
|
||||
|
||||
## Reporting an issue properly
|
||||
|
||||
By following these simple rules you will get better and faster feedback on your issue.
|
||||
|
||||
- [ ] search the bugtracker for an already reported issue
|
||||
- search the bugtracker for an already reported issue
|
||||
|
||||
### If you found an issue that describes your problem:
|
||||
|
||||
- [ ] please read other user comments first, and confirm this is the same issue: a given error condition might be indicative of different problems - you may also find a workaround in the comments
|
||||
- [ ] please refrain from adding "same thing here" or "+1" comments
|
||||
- [ ] you don't need to comment on an issue to get notified of updates: just hit the "subscribe" button
|
||||
- [ ] comment if you have some new, technical and relevant information to add to the case
|
||||
- please read other user comments first, and confirm this is the same issue: a given error condition might be indicative of different problems - you may also find a workaround in the comments
|
||||
- please refrain from adding "same thing here" or "+1" comments
|
||||
- you don't need to comment on an issue to get notified of updates: just hit the "subscribe" button
|
||||
- comment if you have some new, technical and relevant information to add to the case
|
||||
|
||||
### If you have not found an existing issue that describes your problem:
|
||||
|
||||
- [ ] create a new issue, with a succinct title that describes your issue:
|
||||
* bad title: "It doesn't work with my docker"
|
||||
* good title: "Private registry push fail: 400 error with E_INVALID_DIGEST"
|
||||
- [ ] copy the output of `docker version`
|
||||
- [ ] copy the output of `docker info`
|
||||
- [ ] copy your Registry version
|
||||
- [ ] copy the command line you used to launch your Registry
|
||||
- [ ] restart your docker daemon in debug mode (add `-D` to the daemon launch arguments)
|
||||
- [ ] reproduce your problem and get your docker daemon logs showing the error
|
||||
- [ ] if relevant, copy your registry logs that show the error
|
||||
- [ ] provide any relevant detail about your specific Registry configuration (eg: storage backend used)
|
||||
- [ ] indicate if you are using an enterprise proxy, Nginx, or anything else between you and your Registry
|
||||
1. create a new issue, with a succinct title that describes your issue:
|
||||
- bad title: "It doesn't work with my docker"
|
||||
- good title: "Private registry push fail: 400 error with E_INVALID_DIGEST"
|
||||
2. copy the output of:
|
||||
- `docker version`
|
||||
- `docker info`
|
||||
- `docker exec <registry-container> registry -version`
|
||||
3. copy the command line you used to launch your Registry
|
||||
4. restart your docker daemon in debug mode (add `-D` to the daemon launch arguments)
|
||||
5. reproduce your problem and get your docker daemon logs showing the error
|
||||
6. if relevant, copy your registry logs that show the error
|
||||
7. provide any relevant detail about your specific Registry configuration (e.g., storage backend used)
|
||||
8. indicate if you are using an enterprise proxy, Nginx, or anything else between you and your Registry
|
||||
|
||||
## Contributing a patch for a known bug, or a small correction
|
||||
|
||||
You should follow the basic GitHub workflow:
|
||||
|
||||
- [ ] fork
|
||||
- [ ] commit a change
|
||||
- [ ] make sure the tests pass
|
||||
- [ ] PR
|
||||
1. fork
|
||||
2. commit a change
|
||||
3. make sure the tests pass
|
||||
4. PR
|
||||
|
||||
Additionally, you must [sign your commits](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#sign-your-work). It's very simple:
|
||||
|
||||
* configure your name with git: `git config user.name "Real Name" && git config user.email mail@example.com`
|
||||
* sign your commits using `-s`: `git commit -s -m "My commit"`
|
||||
- configure your name with git: `git config user.name "Real Name" && git config user.email mail@example.com`
|
||||
- sign your commits using `-s`: `git commit -s -m "My commit"`
|
||||
|
||||
Some simple rules to ensure quick merge:
|
||||
|
||||
- [ ] clearly point to the issue(s) you want to fix in your PR comment
|
||||
- [ ] when possible, prefer multiple (smaller) PRs addressing individual issues over a big one trying to address multiple issues at once
|
||||
- [ ] if you need to amend your PR following comments, please squash instead of adding more commits
|
||||
- clearly point to the issue(s) you want to fix in your PR comment (e.g., `closes #12345`)
|
||||
- prefer multiple (smaller) PRs addressing individual issues over a big one trying to address multiple issues at once
|
||||
- if you need to amend your PR following comments, please squash instead of adding more commits
|
||||
|
||||
## Contributing new features
|
||||
|
||||
|
|
@ -82,9 +83,9 @@ Your PR will be reviewed by the community, then ultimately by the project mainta
|
|||
|
||||
It's mandatory to:
|
||||
|
||||
* interact respectfully with other community members and maintainers - more generally, you are expected to abide by the [Docker community rules](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#docker-community-guidelines)
|
||||
* address maintainers' comments and modify your submission accordingly
|
||||
* write tests for any new code
|
||||
- interact respectfully with other community members and maintainers - more generally, you are expected to abide by the [Docker community rules](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#docker-community-guidelines)
|
||||
- address maintainers' comments and modify your submission accordingly
|
||||
- write tests for any new code
|
||||
|
||||
Complying to these simple rules will greatly accelerate the review process, and will ensure you have a pleasant experience in contributing code to the Registry.
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue