The Chef Community is committed to keeping our space a fun, safe, and productive place to be, so please review the Community Code of Conduct before getting started. In general:
- Be Kind. We get more done when people are helpful and respectful of one another. Plus, it feels better.
- Listen. Try to understand someone's position before you respond to their suggestion or idea. Ask clarifying questions if something doesn't make sense to you. Understand that others may have a perspective, experience, or technical context that is different from your own.
- Be Patient. We have no team dedicated solely to Community support, so responses will be semi-synchronous, or, more likely, asynchronous. Know that the Community appreciates all your contributions, and we're working to be as responsive as possible.
Please directly email one of the Community Advocates listed in the Code of Conduct.
Please email security@chef.io to report security vulnerabilities.
We have four communication channels, each with its own specific purpose.
If you have questions about why we choose to use certain channels in certain ways, please check out the Frequently Asked Questions.
GitHub is the Chef Community's preferred durable medium for open and transparent development of software. All development conversation must be captured in GitHub. Any decisions made in internal Chef Slack channels, Zoom sessions, or any other communication medium must be summarized in GitHub. Please also link to the GitHub issue or pull request in chat once it is opened.
Sometimes it will make sense to have a brief, non-durable conversation about the development of a project. Have these exchanges in Community Slack (either in a dev channel or via DM). Then, any development decisions, etc. arising from the Slack interaction should be documented in GitHub. Limit these conversations in Community Slack to development for a given project.
The Chef Community mailing lists are hosted via Discourse. This is the best place to catch up on general and security-related announcements.
Individual projects may host office hours on a periodic basis. This is a great way to get some face time with other Project Members. Each project should record and archive sessions to a public location; see individual project documentation for more details.
Note: Zoom is a good medium for office hours. More guidance on this will be coming in the near future.
Please see our support boundaries doc regarding the types of support that are provided by maintainers and the types of support that are not.
Engage like a pro. Below are some best practice uses of the Community communication channels.
As... | if I want to... | I'll... | Notes |
---|---|---|---|
Anyone | become a Project Member | check out the membership overview | Individual project requirements may vary; see project doc for more info. |
Anyone | report a bug | create an issue in GitHub | See sample bug template. Individual projects may have their own templates; see project documentation for details. |
Anyone | submit a feature request | create an issue in GitHub | See sample feature request template. Individual projects may have their own templates; see project documentation for details. |
Anyone | report an outage | email [email address tbd] | --- |
Anyone | report a security vulnerability in a Chef OSS project | email security@chef.io | Encryption? |
A Project Member | join a mailing list | head over to Discourse & sign up | See unsubscribe instructions here. |
A Project Member | join a Community Slack channel | head over to Community Slack | --- |
A Project Member | discuss technical issues | post in GitHub | For general, non-technical questions & issues head over to Community Slack. Use the project's general channel. |
A Project Member | get technical help | ask on GitHub | If the discussion requires a quick, non-durable, real-time sync, move it to the project's dev channel on Community Slack. |
A Project Member | find something to work on | check out GitHub | Get confirmation via a post in GitHub before expending too much effort to avoid duplicate PRs & PRs that won't be merged. |
A Project Member | check out the latest Chef announcements | head over to Discourse | --- |
A Project Member | regain access to your account | [tbd] | --- |
A Project Member | request a PR review | use GitHub | --- |
A Project Member | have a brief non-durable chat | Community Slack | For technical topics, use the project's dev channel. Non-technical topics belong in the general channel. |
A Project Member | become a Reviewer | checkout an overview of Reviewer responsibilities & requirements | Individual project requirements may vary; see project doc for more info. |
A Project Member | report a CoC violation | email [tbd] | --- |
A Project Member | talk to a human | request access to Zoom office hours in Community Slack. | --- |
A Reviewer | become an Approver | check out an overview of Approver responsibilities & requirements | Individual project requirements may vary; see project doc for more info. |
An Approver | vote on a new Project Member, Reviewer, or Approver | review the general requirements and consult my project's documentation | General Approver information is here. Individual project requirements may vary; please see project doc for more info. |