diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c484a70..e41cfff 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,10 +4,10 @@ Welcome to the Chef Community contributing guide. We are excited about the prosp ## Getting Started -This document outlines the process of contributing to this specific repo. See our overall community contribution documentation for more information on contributing to our various projects: +This document outlines the process of contributing to this specific Community repo. See our overall community contribution documentation for more information on contributing to our various projects: - [Contributor Guide](contributors/guide/README.md) - Main contributor documentation -- [Contributor Cheat Sheet](contributors/guide/contributor-cheatsheet.md) - Common resources for existing developers +- [Contributor Cheat Sheet](contributors/guide/contributor-cheatsheet.md) - List of resources for contributors at a glance ## Contributing to Project Specific Sections @@ -15,4 +15,4 @@ Each project may or may not have its own policies for editing their section of t Edits in the Team's sub-directory should follow any additional guidelines described by the respective team leads in the sub-directory's `CONTRIBUTING.md` file (e.g. [teams/habitat/CONTRIBUTING.md](teams/habitat/CONTRIBUTING.md)). -Attending a [team meeting](teams/team-list.md) or posting on their mailing list might be prudent if you want to make extensive contributions. +Attending a [team meeting](teams/team-list.md), or posting on their mailing list might be prudent if you want to make extensive contributions. diff --git a/DCO.md b/DCO.md index 0078180..e72c6a6 100644 --- a/DCO.md +++ b/DCO.md @@ -1,6 +1,6 @@ # Developer Certificate of Origin -All Chef Software Inc. projects utilize a Developer Certificate of Origin (DCO) to ensure that each commit was written by the author or that the author has the appropriate rights necessary to contribute the change. Specifically we utilize [Developer Certificate of Origin, Version 1.1](http://developercertificate.org/) +All Chef Software Inc. projects utilize a Developer Certificate of Origin (DCO) to ensure that each commit was written by the author or that the author has the appropriate rights necessary to contribute the change. Specifically, we utilize [Developer Certificate of Origin, Version 1.1](http://developercertificate.org/) ``` Developer Certificate of Origin diff --git a/guilds/README.md b/guilds/README.md index 2d0647a..89efa51 100644 --- a/guilds/README.md +++ b/guilds/README.md @@ -2,7 +2,7 @@ ## Summary -Guilds have formed in the Chef OSS community in order to foster a culture of learning and empathy. These guilds serve as a place where like-minded people can gather and discuss shared interests tangential to their projects. Currently Chef has formed several language specific guilds (ruby, rust, go). +Guilds have formed in the Chef OSS community in order to foster a culture of learning and empathy. These guilds serve as a place where like-minded people can gather and discuss shared interests that are tangential to their projects. Currently, Chef has formed several language specific guilds (ruby, rust, go). ## Goals of the Language Guilds @@ -10,11 +10,11 @@ Guilds have formed in the Chef OSS community in order to foster a culture of lea - Answer questions about the guild's language use within projects - (Mentor?)Assist new users and developers in learning the language and increasing skills -These guilds consist of multiple people so that decisions are made democratically. The guilds also focus on creating recommended practices, though _not_ enforcement of those practices. Adoption and adherence should occur with the project teams, with documentation written about deviations from a standard or recommendation. +These guilds consist of multiple people, so that decisions are made democratically. The guilds also focus on creating recommended practices, though _not_ enforcement of those practices. Adoption and adherence should occur with the project teams, with documentation written about deviations from a standard or recommendation. ## Recommended Implementation -Successful language specific guilds: - - Have a channel for communication (ex: #rust-guild in Slack) +Successful language-specific guilds: + - Have a channel for communication (e.g. #rust-guild in Slack) - Have periodic meetings where topics can be discussed - Catalog information and results of conversations in a discoverable and accessible way diff --git a/projects-list.md b/projects-list.md index 0234a88..b219d7d 100644 --- a/projects-list.md +++ b/projects-list.md @@ -1,6 +1,6 @@ # Chef Software Projects -Software projects at Chef are made up many libraries and sub-projects managed by Chef. There are currently over 500 such software repositories which together make up our core projects: +Software projects at Chef are made up many libraries and sub-projects managed by Chef. There are currently over 500 such software repositories, which together make up our core projects: - [Chef](https://github.com/chef/chef/) - A systems integration framework, built to bring the benefits of configuration management to your entire infrastructure. - [InSpec](https://github.com/inspec/inspec) - A testing framework for infrastructure with a human- and machine-readable language for specifying compliance, security and policy requirements. @@ -9,7 +9,7 @@ Software projects at Chef are made up many libraries and sub-projects managed by ## Ecosystem Projects -There are many Chef ecosystem projects which are sponsored by Chef Software, but not directly managed by the company. As these are not official Chef Software projects they will have their own GitHub organizations as well as contribution processes. See the individual projects for more information on getting involved. +There are many Chef ecosystem projects, which are sponsored by Chef Software, but not directly managed by the company. As these are not official Chef Software projects, they will have their own GitHub organizations as well as contribution processes. See the individual projects for more information on getting involved. - [Test Kitchen](https://github.com/test-kitchen/) - [Foodcritic](https://github.com/foodcritic/) diff --git a/repo-management/README.md b/repo-management/README.md index 4fe15e0..4cfcb96 100644 --- a/repo-management/README.md +++ b/repo-management/README.md @@ -1,6 +1,6 @@ # Repo Management -Ready to create a new Chef Open Source project? Looking for some guidance on how to manage repositories for existing projects? You have come to the right place! +Ready to create a new Chef Open Source Software project? Looking for some guidance on how to manage repositories for existing projects? You have come to the right place! ## Project Setup diff --git a/repo-management/project-required-setup.md b/repo-management/project-required-setup.md index 50b259d..d5784d8 100644 --- a/repo-management/project-required-setup.md +++ b/repo-management/project-required-setup.md @@ -46,7 +46,7 @@ The LICENSE file is an important legal requirement for open source code, and it ### CONTRIBUTING.md -GitHub prompts new contributors to read a project's CONTRIBUTING.md file if present. Each project should include a file that details the team specific contribution process and links to the [Contributor Guide](../contributors/README.md) guide in this repository. +GitHub prompts new contributors to read a project's CONTRIBUTING.md file if present. Each project should include a file that details the team specific contribution process and links to the [Contributor Guide](../contributors/README.md) in this repository. ### CODE_OF_CONDUCT.md diff --git a/repo-management/repo-states.md b/repo-management/repo-states.md index 3c3ba4e..774b68c 100644 --- a/repo-management/repo-states.md +++ b/repo-management/repo-states.md @@ -7,11 +7,11 @@ A Chef OSS repo can be in one of 3 states ## Active -Repos in an active state are under active development - including bug fixes, new features, and more. Repos that are in this state must have at least two maintainers who are current employees of Chef Software, Inc. SLA on response to issues or pull requests should be less than 1 business week. +Repos in an active state are under active development - including bug fixes, new features, and more. Repos in this active state must have at least two maintainers, who are current employees of Chef Software, Inc. SLA on response to issues or pull requests should be less than 1 business week. ## Maintained -Repos in a maintained state are maintained and bugs will be fixed, but no new feature work should be expected. Repos that are in this state must have at least one maintainer who is a current employee of Chef Software, Inc. SLA on response to issues or pull requests should be anywhere from 1 business week to never. +Repos in a maintained state are maintained where bugs will be fixed, but no new feature work should be expected. Repos in this maintained state must have at least one maintainer, who is a current employee of Chef Software, Inc. SLA on response to issues or pull requests should be anywhere from 1 business week to never. ## Deprecated