This repository has been archived by the owner on Jun 24, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #3 from euank/update-boilerplate
Update boilerplate
- Loading branch information
Showing
6 changed files
with
193 additions
and
2 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,77 @@ | ||
# How to Contribute | ||
|
||
CoreOS projects are [Apache 2.0 licensed](LICENSE) and accept contributions via | ||
GitHub pull requests. This document outlines some of the conventions on | ||
development workflow, commit message formatting, contact points and other | ||
resources to make it easier to get your contribution accepted. | ||
|
||
# Certificate of Origin | ||
|
||
By contributing to this project you agree to the Developer Certificate of | ||
Origin (DCO). This document was created by the Linux Kernel community and is a | ||
simple statement that you, as a contributor, have the legal right to make the | ||
contribution. See the [DCO](DCO) file for details. | ||
|
||
# Email and Chat | ||
|
||
The project currently uses the general CoreOS email list and IRC channel: | ||
- Email: [coreos-dev](https://groups.google.com/forum/#!forum/coreos-dev) | ||
- IRC: #[coreos](irc://irc.freenode.org:6667/#coreos) IRC channel on freenode.org | ||
|
||
Please avoid emailing maintainers found in the MAINTAINERS file directly. They | ||
are very busy and read the mailing lists. | ||
|
||
## Getting Started | ||
|
||
- Fork the repository on GitHub | ||
- Read the [README](README.md) for build and test instructions | ||
- Play with the project, submit bugs, submit patches! | ||
|
||
## Contribution Flow | ||
|
||
This is a rough outline of what a contributor's workflow looks like: | ||
|
||
- Create a topic branch from where you want to base your work (usually master). | ||
- Make commits of logical units. | ||
- Make sure your commit messages are in the proper format (see below). | ||
- Push your changes to a topic branch in your fork of the repository. | ||
- Make sure the tests pass, and add any new tests as appropriate. | ||
- Submit a pull request to the original repository. | ||
|
||
Thanks for your contributions! | ||
|
||
### Coding Style | ||
|
||
CoreOS projects written in Go follow a set of style guidelines that we've documented | ||
[here](https://github.com/coreos/docs/tree/master/golang). Please follow them when | ||
working on your contributions. | ||
|
||
### Format of the Commit Message | ||
|
||
We follow a rough convention for commit messages that is designed to answer two | ||
questions: what changed and why. The subject line should feature the what and | ||
the body of the commit should describe the why. | ||
|
||
``` | ||
scripts: add the test-cluster command | ||
this uses tmux to setup a test cluster that you can easily kill and | ||
start for debugging. | ||
Fixes #38 | ||
``` | ||
|
||
The format can be described more formally as follows: | ||
|
||
``` | ||
<subsystem>: <what changed> | ||
<BLANK LINE> | ||
<why this change was made> | ||
<BLANK LINE> | ||
<footer> | ||
``` | ||
|
||
The first line is the subject and should be no longer than 70 characters, the | ||
second line is always blank, and other lines should be wrapped at 80 characters. | ||
This allows the message to be easier to read on GitHub as well as in various | ||
git tools. |
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,36 @@ | ||
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. |
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
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,5 @@ | ||
CoreOS Project | ||
Copyright 2017 CoreOS, Inc | ||
|
||
This product includes software developed at CoreOS, Inc. | ||
(http://www.coreos.com/). |
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
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,63 @@ | ||
## CoreOS Community Code of Conduct | ||
|
||
### Contributor Code of Conduct | ||
|
||
As contributors and maintainers of this project, and in the interest of | ||
fostering an open and welcoming community, we pledge to respect all people who | ||
contribute through reporting issues, posting feature requests, updating | ||
documentation, submitting pull requests or patches, and other activities. | ||
|
||
We are committed to making participation in this project a harassment-free | ||
experience for everyone, regardless of level of experience, gender, gender | ||
identity and expression, sexual orientation, disability, personal appearance, | ||
body size, race, ethnicity, age, religion, or nationality. | ||
|
||
Examples of unacceptable behavior by participants include: | ||
|
||
* The use of sexualized language or imagery | ||
* Personal attacks | ||
* Trolling or insulting/derogatory comments | ||
* Public or private harassment | ||
* Publishing others' private information, such as physical or electronic addresses, without explicit permission | ||
* Other unethical or unprofessional conduct. | ||
|
||
Project maintainers have the right and responsibility to remove, edit, or | ||
reject comments, commits, code, wiki edits, issues, and other contributions | ||
that are not aligned to this Code of Conduct. By adopting this Code of Conduct, | ||
project maintainers commit themselves to fairly and consistently applying these | ||
principles to every aspect of managing this project. Project maintainers who do | ||
not follow or enforce the Code of Conduct may be permanently removed from the | ||
project team. | ||
|
||
This code of conduct applies both within project spaces and in public spaces | ||
when an individual is representing the project or its community. | ||
|
||
Instances of abusive, harassing, or otherwise unacceptable behavior may be | ||
reported by contacting a project maintainer, Brandon Philips | ||
<brandon.philips@coreos.com>, and/or Meghan Schofield | ||
<meghan.schofield@coreos.com>. | ||
|
||
This Code of Conduct is adapted from the Contributor Covenant | ||
(http://contributor-covenant.org), version 1.2.0, available at | ||
http://contributor-covenant.org/version/1/2/0/ | ||
|
||
### CoreOS Events Code of Conduct | ||
|
||
CoreOS events are working conferences intended for professional networking and | ||
collaboration in the CoreOS community. Attendees are expected to behave | ||
according to professional standards and in accordance with their employer’s | ||
policies on appropriate workplace behavior. | ||
|
||
While at CoreOS events or related social networking opportunities, attendees | ||
should not engage in discriminatory or offensive speech or actions including | ||
but not limited to gender, sexuality, race, age, disability, or religion. | ||
Speakers should be especially aware of these concerns. | ||
|
||
CoreOS does not condone any statements by speakers contrary to these standards. | ||
CoreOS reserves the right to deny entrance and/or eject from an event (without | ||
refund) any individual found to be engaging in discriminatory or offensive | ||
speech or actions. | ||
|
||
Please bring any concerns to the immediate attention of designated on-site | ||
staff, Brandon Philips <brandon.philips@coreos.com>, and/or Meghan Schofield | ||
<meghan.schofield@coreos.com>. |