forked from docker/genai-stack
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add contributing guidelines (docker#68)
- Loading branch information
1 parent
2d5b16e
commit ed5d1a0
Showing
1 changed file
with
250 additions
and
0 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,250 @@ | ||
# Contributing to Docker | ||
|
||
This page contains information about reporting issues as well as some tips and | ||
guidelines useful to experienced open source contributors. Finally, make sure | ||
you read our [community guidelines](#docker-community-guidelines) before you | ||
start participating. | ||
|
||
## Topics | ||
|
||
* [Reporting Security Issues](#reporting-security-issues) | ||
* [Reporting Issues](#reporting-other-issues) | ||
* [Quick Contribution Tips and Guidelines](#quick-contribution-tips-and-guidelines) | ||
* [Community Guidelines](#docker-community-guidelines) | ||
|
||
## Reporting security issues | ||
|
||
The Docker maintainers take security seriously. If you discover a security | ||
issue, please bring it to their attention right away! | ||
|
||
Please **DO NOT** file a public issue, instead send your report privately to | ||
[[email protected]](mailto:[email protected]). | ||
|
||
Security reports are greatly appreciated and we will publicly thank you for it. | ||
We also like to send gifts—if you're into Docker schwag, make sure to let | ||
us know. We currently do not offer a paid security bounty program, but are not | ||
ruling it out in the future. | ||
|
||
## Reporting other issues | ||
|
||
A great way to contribute to the project is to send a detailed report when you | ||
encounter an issue. We always appreciate a well-written, thorough bug report, | ||
and will thank you for it! | ||
|
||
Check that [our issue database](https://github.com/docker/gen-ai-stack/issues) | ||
doesn't already include that problem or suggestion before submitting an issue. | ||
If you find a match, you can use the "subscribe" button to get notified on | ||
updates. Do *not* leave random "+1" or "I have this too" comments, as they | ||
only clutter the discussion, and don't help resolving it. However, if you | ||
have ways to reproduce the issue or have additional information that may help | ||
resolving the issue, please leave a comment. | ||
|
||
When reporting issues, always include: | ||
|
||
* The output of `docker version`. | ||
* The output of `docker info`. | ||
|
||
Also include the steps required to reproduce the problem if possible and | ||
applicable. This information will help us review and fix your issue faster. | ||
When sending lengthy log-files, consider posting them as a gist (https://gist.github.com). | ||
Don't forget to remove sensitive data from your logfiles before posting (you can | ||
replace those parts with "REDACTED"). | ||
|
||
## Quick contribution tips and guidelines | ||
|
||
This section gives the experienced contributor some tips and guidelines. | ||
|
||
### Pull requests are always welcome | ||
|
||
Not sure if that typo is worth a pull request? Found a bug and know how to fix | ||
it? Do it! We will appreciate it. Any significant improvement should be | ||
documented as [a GitHub issue](https://github.com/docker/gen-ai-stack/issues) before | ||
anybody starts working on it. | ||
|
||
We are always thrilled to receive pull requests. We do our best to process them | ||
quickly. If your pull request is not accepted on the first try, | ||
don't get discouraged! Our contributor's guide explains [the review process we | ||
use for simple changes](https://docs.docker.com/opensource/workflow/make-a-contribution/). | ||
|
||
### Talking to other Docker users and contributors | ||
|
||
<table class="tg"> | ||
<col width="45%"> | ||
<col width="65%"> | ||
<tr> | ||
<td>Community Slack</td> | ||
<td> | ||
The Docker Community has a dedicated Slack chat to discuss features and issues. You can sign-up <a href="https://dockr.ly/slack" target="_blank">with this link</a>. | ||
</td> | ||
</tr> | ||
<tr> | ||
<td>Twitter</td> | ||
<td> | ||
You can follow <a href="https://twitter.com/docker/" target="_blank">Docker's Twitter feed</a> | ||
to get updates on our products. You can also tweet us questions or just | ||
share blogs or stories. | ||
</td> | ||
</tr> | ||
</table> | ||
|
||
|
||
### Conventions | ||
|
||
Fork the repository and make changes on your fork in a feature branch: | ||
|
||
- If it's a bug fix branch, name it XXXX-something where XXXX is the number of | ||
the issue. | ||
- If it's a feature branch, create an enhancement issue to announce | ||
your intentions, and name it XXXX-something where XXXX is the number of the | ||
issue. | ||
|
||
Pull request descriptions should be as clear as possible and include a reference | ||
to all the issues that they address. | ||
|
||
Commit messages must start with a capitalized and short summary (max. 50 chars) | ||
written in the imperative, followed by an optional, more detailed explanatory | ||
text which is separated from the summary by an empty line. | ||
|
||
Code review comments may be added to your pull request. Discuss, then make the | ||
suggested modifications and push additional commits to your feature branch. Post | ||
a comment after pushing. New commits show up in the pull request automatically, | ||
but the reviewers are notified only when you comment. | ||
|
||
Pull requests must be cleanly rebased on top of master without multiple branches | ||
mixed into the PR. | ||
|
||
**Git tip**: If your PR no longer merges cleanly, use `rebase main` in your | ||
feature branch to update your pull request rather than `merge main`. | ||
|
||
Before you make a pull request, squash your commits into logical units of work | ||
using `git rebase -i` and `git push -f`. A logical unit of work is a consistent | ||
set of patches that should be reviewed together: for example, upgrading the | ||
version of a vendored dependency and taking advantage of its now available new | ||
feature constitute two separate units of work. Implementing a new function and | ||
calling it in another file constitute a single logical unit of work. The very | ||
high majority of submissions should have a single commit, so if in doubt: squash | ||
down to one. | ||
|
||
Include an issue reference like `Closes #XXXX` or `Fixes #XXXX` in the pull request | ||
description that close an issue. Including references automatically closes the issue | ||
on a merge. | ||
|
||
### Sign your work | ||
|
||
The sign-off is a simple line at the end of the explanation for the patch. Your | ||
signature certifies that you wrote the patch 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](https://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`. | ||
|
||
## Docker community guidelines | ||
|
||
We want to keep the Docker community awesome, growing and collaborative. We need | ||
your help to keep it that way. To help with this we've come up with some general | ||
guidelines for the community as a whole: | ||
|
||
* Be nice: Be courteous, respectful and polite to fellow community members: | ||
no regional, racial, gender, or other abuse will be tolerated. We like | ||
nice people way better than mean ones! | ||
|
||
* Encourage diversity and participation: Make everyone in our community feel | ||
welcome, regardless of their background and the extent of their | ||
contributions, and do everything possible to encourage participation in | ||
our community. | ||
|
||
* Keep it legal: Basically, don't get us in trouble. Share only content that | ||
you own, do not share private or sensitive information, and don't break | ||
the law. | ||
|
||
* Stay on topic: Make sure that you are posting to the correct channel and | ||
avoid off-topic discussions. Remember when you update an issue or respond | ||
to an email you are potentially sending to a large number of people. Please | ||
consider this before you update. Also remember that nobody likes spam. | ||
|
||
* Don't send email to the maintainers: There's no need to send email to the | ||
maintainers to ask them to investigate an issue or to take a look at a | ||
pull request. Instead of sending an email, GitHub mentions should be | ||
used to ping maintainers to review a pull request, a proposal or an | ||
issue. | ||
|
||
### Guideline violations — 3 strikes method | ||
|
||
The point of this section is not to find opportunities to punish people, but we | ||
do need a fair way to deal with people who are making our community suck. | ||
|
||
1. First occurrence: We'll give you a friendly, but public reminder that the | ||
behavior is inappropriate according to our guidelines. | ||
|
||
2. Second occurrence: We will send you a private message with a warning that | ||
any additional violations will result in removal from the community. | ||
|
||
3. Third occurrence: Depending on the violation, we may need to delete or ban | ||
your account. | ||
|
||
**Notes:** | ||
|
||
* Obvious spammers are banned on first occurrence. If we don't do this, we'll | ||
have spam all over the place. | ||
|
||
* Violations are forgiven after 6 months of good behavior, and we won't hold a | ||
grudge. | ||
|
||
* People who commit minor infractions will get some education, rather than | ||
hammering them in the 3 strikes process. | ||
|
||
* The rules apply equally to everyone in the community, no matter how much | ||
you've contributed. | ||
|
||
* Extreme violations of a threatening, abusive, destructive or illegal nature | ||
will be addressed immediately and are not subject to 3 strikes or forgiveness. | ||
|
||
* Contact [email protected] to report abuse or appeal violations. In the case of | ||
appeals, we know that mistakes happen, and we'll work with you to come up with a | ||
fair solution if there has been a misunderstanding. | ||
|