Skip to content

Commit

Permalink
I'm very sorry... this is a lot of change
Browse files Browse the repository at this point in the history
Signed-off-by: Ian Henry <[email protected]>
  • Loading branch information
Ian Henry authored and robbkidd committed Feb 8, 2019
1 parent a294c96 commit 7c561a4
Show file tree
Hide file tree
Showing 13 changed files with 535 additions and 276 deletions.
55 changes: 55 additions & 0 deletions DCO.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# 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/)

```
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.
```

Each commit must include a DCO which looks like this

`Signed-off-by: Joe Smith <[email protected]>`

The project requires that the name used is your real name. Neither anonymous contributors nor those
utilizing pseudonyms will be accepted.

Git makes it easy to add this line to your commit messages. Make sure the `user.name` and
`user.email` are set in your git configs. Use `-s` or `--signoff` to add the Signed-off-by line to
the end of the commit message.
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,13 @@ Welcome to the Chef Software OSS communities!

This is a starting point for contributing to all of Chef's software and a wonderful spot for information on how to join in on the fun.

To learn more about each of our project's structure and organization, please refer to [Project Governance](to be added later) information.
To learn more about each of our project's structure and organization, please refer to [Project Governance](/governance.md) information.

## How We're Organized

Chef Software (the company) produces many products such as Chef, InSpec, and Habitat. Each of these products is fully open source and comprised of one or more open source projects. For instance the Chef product is comprised of chef, ohai, various mixlib projects, and more.
Chef Software (the company) produces many products such as Chef, InSpec, and Habitat. Each of these products is fully open source and comprised of one or more open source projects. For instance the Chef product is comprised of chef, ohai, various mixlib projects, and other interdependent libraries. The project and/or sub-project scope is defined in each GitHub repository in the README.md file.

Many of our projects include sub-projects, which are repositories of code that are tightly coupled to another project. For example the InSpec project has a sub-project of `kitchen-inspec` as changes to the InSpec codebase more than often require updates to `kitchen-inspec`. The project and sub-project scope is defined in each GitHub repository in the README.md file.

All governance of Chef projects operates within the requirements set by the Chef OSS Practices committee, all of which are documented under [Governance](governance.md), however *Teams* can have their own policy for contribution, described in their `CONTRIBUTING.md` file in their project repo (e.g. habitat/CONTRIBUTING.md), communication standards, etc. so long as those policies meet the base Chef Software policy.
All Chef projects operate under governance determined by the Chef OSS Practices Committee. These policies are documented under [Governance](/governance.md), however *Teams* can have their own [policy for contribution](/repo-management/project-required-setup.md#CONTRIBUTING.md), communication standards, etc. so long as those policies meet the base governance policy.

## Communicating With Us

Expand All @@ -24,11 +22,11 @@ For more specific topics, check out an individual project.

A first step towards contributing is to pick from the [list of Chef Software Projects](added later). Read the team's contribution policy (CONTRIBUTING.md), start attending team meetings, join the chat channel, subscribe to the mailing list. Teams will have a set of "Help Wanted" issues that can help new contributors get involved.

The [Contributor Guide] provides detailed instructions on how to get your code accepted into core including:
The [Contributor Guide](/contributors/guide) provides detailed instructions on how to get your code accepted into core including:

1. Doing a thing!
2. Doing some other thing!
3. Perhaps doing a final thing!?
1. How to [file an issue](/contributors/guide/README.md#File-an-issue)
2. How to [find something to work on](/contributors/guide/README.md#Find-something-to-work-on)
3. How to [open a pull request](/contributors/guide/README.md#Open-a-pull-request)

## Project Membership

Expand Down
File renamed without changes.
51 changes: 28 additions & 23 deletions contributors/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,33 @@ Feel free to browse the [open issues](https://github.com/chef/chef-oss-practices

Welcome to the Chef Software Inc. OSS Community!

- [Before you get started](#before-you-get-started)
- [Signing the DCO](#signing-the-dco)
- [Code of Conduct](#code-of-conduct)
- [Community Expectations and Roles](#community-expectations-and-roles)
- [Thanks](#thanks)
- [Your First Contribution](#your-first-contribution)
- [Find something to work on](#find-something-to-work-on)
- [Find a good first topic](#find-a-good-first-topic)
- [Learn about teams](#learn-about-team)
- [File an Issue](#file-an-issue)
- [Contributing](#contributing)
- [Communication](#communication)
- [GitHub workflow](#github-workflow)
- [Open a Pull Request](#open-a-pull-request)
- [Code Review](#code-review)
- [Testing](#testing)
- [Security](#security)
- [Issues Management or Triage](#issues-management-or-triage)
- [Community](#community)
- [Communication](#communication-1)
- [Events](#events)
- [Mentorship](#mentorship)
- [Chef Software Inc. Contributor Guide](#chef-software-inc-contributor-guide)
- [Welcome](#welcome)
- [Before you get started](#before-you-get-started)
- [Signing the DCO](#signing-the-dco)
- [Code of Conduct](#code-of-conduct)
- [Community Expectations and Roles](#community-expectations-and-roles)
- [Your First Contribution](#your-first-contribution)
- [Find something to work on](#find-something-to-work-on)
- [Find a good first topic](#find-a-good-first-topic)
- [Issue Assignment in Github](#issue-assignment-in-github)
- [Learn about Teams](#learn-about-teams)
- [Team structure](#team-structure)
- [Find a team that is related to your contribution](#find-a-team-that-is-related-to-your-contribution)
- [File an Issue](#file-an-issue)
- [Contributing](#contributing)
- [Communication](#communication)
- [GitHub workflow](#github-workflow)
- [Open a Pull Request](#open-a-pull-request)
- [Code Review](#code-review)
- [Testing](#testing)
- [Security](#security)
- [Issues Management or Triage](#issues-management-or-triage)
- [Community](#community)
- [Communication](#communication-1)
- [Events](#events)
- [Mentorship](#mentorship)
- [Advanced Topics](#advanced-topics)

# Before you get started

Expand Down Expand Up @@ -178,7 +183,7 @@ To make it easier for your PR to receive reviews, consider the reviewers will ne
* follow the project [coding conventions](coding-conventions.md) (which may be defined by a language specific guild)
* write [good commit messages](https://chris.beams.io/posts/git-commit/)
* break large changes into a logical series of smaller commits which individually make easily understandable changes, and in aggregate solve a broader issue
* label PRs with appropriately: check out our section on [github labels](/github_labels.md)
* label PRs with appropriately: check out our section on [github labels](/github-labels.md)

Reviewers, the people giving the review, are highly encouraged to revisit the [Code of Conduct](/CODE_OF_CONDUCT.md) and must go above and beyond to promote a collaborative, respectful community.
When reviewing PRs from others [The Gentle Art of Patch Review](http://sage.thesharps.us/2014/09/01/the-gentle-art-of-patch-review/) suggests an iterative series of focuses which is designed to lead new contributors to positive collaboration without inundating them initially with nuances:
Expand Down
Loading

0 comments on commit 7c561a4

Please sign in to comment.