Permalink
Browse files

Publish the Project Razor project governance documents

This includes a contributing guide for new members of the community, pointers
to the resources we make available, and a list of the committers on
the project.

Signed-off-by: Daniel Pittman <daniel@rimspace.net>
  • Loading branch information...
1 parent ec9868b commit 1d31124cdac78877f1507a5074f6003b11d3c385 @slippycheeze slippycheeze committed Oct 29, 2012
Showing with 315 additions and 71 deletions.
  1. +266 −0 CONTRIBUTING.md
  2. +2 −2 LICENSE
  3. +0 −8 Punchlist.md
  4. +47 −18 README.markdown → README.md
  5. +0 −43 README_Developer.markdown
View
@@ -0,0 +1,266 @@
+# How to contribute
+
+Razor is an open project, and community contributions are essential for
+keeping it great. We can't access the huge number of platforms and myriad of
+hardware, software, and deployment configurations that Razor is intended
+to serve.
+
+We want to keep it as easy as possible to contribute changes that get things
+working in your environment. There are a few guidelines that we need
+contributors to follow so that we can have a chance of keeping on top
+of things.
+
+
+## Getting Started
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Submit a ticket for your issue, assuming one does not already exist.
+ * Razor tickets are filed on the GitHub project:
+ https://github.com/puppetlabs/razor/issues
+ * Please try to clearly describe the issue, including the steps to reproduce
+ any bug.
+ * Please include the story of "why" you want to do something.
+* Fork the repository on GitHub.
+* Glance at the [Git Best Practices][best-practice] document, even if you
+ don't read it all yet.
+* If this is a new feature, make sure you discuss it on the
+ [puppet-razor mailing list][puppet-razor] before getting started on code.
+
+
+## How to Get Help
+
+We really want Razor to be simple to contribute to, and to ensure that you can
+get started quickly. A big part of that is being available to help you figure
+out the right way to solve a problem, and to make sure you get up to
+speed quickly.
+
+You can always reach out and ask for help:
+
+* by email or through the web on the [puppet-razor@googlegroups.com][puppet-razor]
+ mailing list. (membership is required to post.)
+* by IRC, through [#puppet-razor][irc] on [the FreeNode IRC network][freenode].
+
+
+## Discuss Your Change
+
+You should start by discussing your change in public:
+* for small but clear changes, [open an issue describing the bug or feature][bugs].
+* for larger changes, send an email to puppet-dev@googlegroups.com or
+ [post through the web][puppet-dev] before creating the issue.
+
+Any and all members of the community can respond to an issue, and make
+comments or suggestions. You should take these comments seriously, but you
+are not obliged to do what they say.
+
+If the issue is going in the wrong direction, one of the project leaders will
+comment within 14 days, so that you don't waste time building a solution that
+won't be accepted. If you don’t get a response you can @mention a committer
+in a GitHub message, or CC a committer to the discussion thread.
+
+While we love getting code submitted to our projects, the act of submitting
+code does not guarantee it will be merged. This is why we encourage discussion
+prior to code submissions.
+
+This gives three outcomes from the discussion:
+
+1. There is no approval or rejection, so a pull request may not be accepted
+ further down the line.
+2. A committer approves the proposal, so a pull request will be accepted once
+ it is ready - it fits stylistically, has no implementation problems, and
+ has suitable tests.
+3. A committer rejects the proposal, and the issue is closed, or is rewritten
+ until it is acceptable.
+
+
+## Making Changes
+
+* Create a topic branch for your work.
+ * You should branch off the `master` branch.
+ * Name your branch by the type of contribution and target:
+ * Generally, the type is `bug`, or `feature`, but if they don't fit pick
+ something sensible.
+ * To create a topic branch based on master:
+ `git checkout master && git pull && git checkout -b bug/master/my_contribution`
+* Don't work directly on the `master` branch, or any other core branch.
+ Your pull request will be rejected unless it is on a topic branch.
+* Every commit should do one thing, and only one thing.
+* Having too many commits is better than having too few commits.
+* Check for unnecessary whitespace with `git diff --check` before committing.
+* Make sure your commit messages are in the proper format.
+
+````
+ (#99999) Make the example in CONTRIBUTING imperative and concrete
+
+ Without this patch applied the example commit message in the CONTRIBUTING
+ document is not a concrete example. This is a problem because the
+ contributor is left to imagine what the commit message should look like
+ based on a description rather than an example. This patch fixes the
+ problem by making the example concrete and imperative.
+
+ The first line is a real life imperative statement with a ticket number
+ from our issue tracker. The body describes the behavior without the patch,
+ why this is a problem, and how the patch fixes the problem when applied.
+````
+
+* Make sure you have added tests for your changes.
+* Run _all_ the tests to assure nothing else was accidentally broken.
+ * If possible, run the acceptance tests as well as the unit tests.
+ * You can *always* ask for help getting the tests working, or with
+ writing tests.
+
+## Branching, and Where Changes Go
+
+Until a stable version of Razor is shipped, there is only one branch:
+`master`. All changes target that branch.
+
+### Branch and Version Compatibility
+
+Any change to Razor branch should strive as much as possible to be compatible
+with all released versions of Razor. We want to avoid multiple incompatible
+versions existing as much as possible.
+
+Until 1.0.0 we are willing to accept backward-incompatible changes if there is
+no possible way around it. Those changes MUST provide a migration strategy
+and, if possible, deprecation warnings about the older functionality.
+
+Right now any change committed to `master` must be considered "live".
+
+
+## Submitting Changes
+
+* Push your changes to a topic branch in your fork of the repository.
+* Submit a pull request to the repository in the puppetlabs organization.
+* Update your ticket to mark that you have submitted code and are ready to be
+ reviewed, if it is separate from the pull request.
+ * Mentioning the issue number in the subject will make this happen through
+ GitHub magic.
+* A committer checks that the pull request is well formed. If not, they will
+ ask that it is fixed:
+ 1. it is on it's own, appropriately named, branch.
+ 2. it was submitted to an appropriate target branch.
+ 3. it only has commits relevant to the specific issue.
+ 4. it has appropriate, clear, and effective commit messages.
+* A committer can start a pull request specific discussion; at this point that covers:
+ 1. Reviewing the code for any obvious problems.
+ 2. Providing feedback based on personal experience on the subject.
+ 3. Testing relevant examples on an untested platform.
+ 4. Thoroughly stepping through the change to understand potential side-effects.
+ 5. Examining discrepancies between the original issue and the pull request.
+ 6. Using @mentioning to involve another committer in the discussion.
+
+Anyone can offer their assessment of a pull request, or be involved in the
+discussion, but keep in mind that this isn't the time to decide if the pull
+request is desired or not. The only reason it should be rejected at this
+point is if someone skipped the earlier steps in the process and submitted
+code before any discussion happened.
+
+* Every review should add any specific changes required to the pull request:
+ * For comments on specific code, using GitHub line comments.
+ * For general changes, include them in the final assessment.
+* Every review should end by specifying the type of review, and a vote:
+ 1. Good to merge.
+ 2. Good to merge with minor changes (which are specified, or line comments).
+ 3. Not good to merge without major changes (which are specified).
+* Any committer can merge after there is a vote of "good to merge".
+ 1. Committers are trusted to do the right thing - you can merge your own code, but you should make sure you get appropriate independent review.
+ 2. Most changes should not merge unless a code review has been completed.
+* If the pull request is not reviewed within 14 days, you can ask any committer to execute the merge regardless:
+ * This can be blocked at any time by a single constructive vote against
+ merging ("Don't merge this, until you change...")
+ * This is not stopped by a non-constructive vote (Don't merge this, I have
+ not had a chance to look at it yet.")
+ * The committer is encouraged to review before merging.
+
+## Implications of Voting
+
+In some communities, voting positively comes with the implication "I approve
+*and* I'm willing to help." An unfavorable vote comes with the implication "I
+disagree, but I am willing to work with you to figure out a better solution."
+
+We hold the view that these implications should be fully spelled out: a vote
+is a formal expression of opinion, not a commitment to take any specific
+action, other than what we explicitly spell out.
+
+
+## Binding Votes
+
+The basic rule is that only project committers have a binding vote.
+Votes outside that indicate personal taste, but don’t have the same weight.
+That said, effective community members "personal taste" can and do shape the
+direction of decisions.
+
+## How Voting Works
+
+Votes are expressed as a number between -1 and +1, with '-1' meaning 'no', and
+'+1' meaning 'yes'. '+0' means "I don't think we should, but I don't object",
+and '-0' means "I think we shouldn't, but won't argue". Values in between sit
+somewhere between the two extremes.
+
+These numbers are guidelines. If you want to understand what someone means by
+their vote, ask them. In general, as a voter, you should prefer an integer
+vote to a fractional vote, for the sake of simplicity and sanity everywhere.
+
+
+## Consensus
+
+Voting is active: if you don't express a vote you abstain, and the other
+opinions will carry the day. Staying silent is not a way to say "don't do
+this." On the same side, a vote is never "silence is consent."
+
+
+## Becoming a Committer
+
+Razor is an open project: any contributor can become a committer. Being a
+committer comes with great responsibility: your decisions directly shape the
+community, and the effectiveness, of the Razor project. You will probably
+invest more, and produce less, as a committer than a regular developer
+submitting pull requests.
+
+As a committer your code is subject to the same review and commit restrictions
+as regular committers. You must exercise greater caution that most people in
+what you submit and include in the project.
+
+On the other hand you have several additional responsibilities over and above
+those of a regular developer:
+1. You are responsible for reviewing and voting on inclusion of code from
+ other developers.
+ * You are responsible for giving constructive feedback that action can be
+ taken on when code isn't quite there yet
+2. You are responsible for ensuring that quality, tested code is committed.
+3. You are responsible for ensuring that code merges into the
+ appropriate branch.
+4. You are responsible for ensuring that our community is diverse, accepting,
+ and friendly.
+5. You are responsible for voting in a timely fashion, where required.
+
+The best way to become a committer is to fulfill those requirements in the
+community, so that it is clear that approving you is just a formality.
+
+The process for adding a committer is:
+1. A candidate has demonstrated familiarity with the quality guidelines and
+ coding standards by submitting at least two pull requests that are accepted
+ without modification.
+2. The candidate is proposed by an existing committer.
+3. A formal vote is held on the project private mailing list.
+5. Existing committers vote on the candidate:
+ * yes, accept them as a committer.
+ * no, do not accept them as a committer.
+6. If a majority of existing committers vote positively, the new committer
+ is added to the public list of committers, and announced on the mailing list.
+
+Voting on adding a committer is absolutely private, and any feedback to
+candidates about why they were not accepted is at the option of the
+project leader.
+
+### Removing Committers
+
+Removing a committer happens if they don't live up to their responsibilities,
+or if they violate the community standards. This is done by the project
+leader. The details of why are private, and will not be shared.
+
+
+[bugs]: https://github.com/puppetlabs/razor/issues
+[best-practice]: http://sethrobertson.github.com/GitBestPractices/
+[puppet-razor]: https://groups.google.com/forum/?fromgroups#!forum/puppet-razor
+[irc]: https://webchat.freenode.net/?channels=puppet-razor
+[freenode]: http://freenode.net/
View
@@ -3,8 +3,8 @@ Copyright (C) 2012 EMC Corporation
Puppet Labs can be contacted at: info@puppetlabs.com
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
+Licensed under the Apache License, Version 2.0 (the "License"); you may not
+use or distribute Project Razor except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
View
@@ -1,8 +0,0 @@
-# Long Pole TODO
-
-1. Image service
-1a. GLance integration into Image Service
-2. Proper error classes and methods to retrieve, monitor, and send (syslog)
-3. Power Control
-4. Web Management interface
-5. Storage provisioning (Model or Policy based)
@@ -8,7 +8,14 @@ Project Razor is a power control, provisioning, and management application
designed to deploy both bare-metal and virtual computer resources. Razor
provides broker plugins for integration with third party such as Puppet.
-This is a 0.x release, so the CLI and API is still in flux and may change. Make sure you __read the release notes before upgrading__
+This is a 0.x release, so the CLI and API is still in flux and may
+change. Make sure you __read the release notes before upgrading__
+
+Project Razor is versioned with [semantic versioning][semver], and we follow
+the precepts of that document. Right now that means that breaking changes are
+permitted to both the API and internals, although we try to keep compatibility
+as far as reasonably possible.
+
## How to Get Help
@@ -23,14 +30,16 @@ You can always reach out and ask for help:
mailing list. (membership is required to post.)
* by IRC, through [#puppet-razor][irc] on [freenode][freenode].
-[puppet-razor]: https://groups.google.com/forum/?fromgroups#!forum/puppet-razor
-[irc]: irc://chat.freenode.net/puppet-razor
-[freenode]: http://freenode.net/
+If you want to help improve Razor directly we have a
+[fairly detailed CONTRIBUTING guide in the repository][contrib] that you can
+use to understand how code gets in to the system, how the project runs, and
+how to make changes yourself.
-## Authors
+We welcome contributions at all levels, including working strictly on our
+documentation, tests, or code contributions. We also welcome, and value,
+input about your experiences with Project Razor, and provisioning in general,
+on the mailing list as we discuss how the project should solve problems.
-* [Nicholas Weaver](https://github.com/lynxbat)
-* [Tom McSweeney](https://github.com/tjmcs)
## Installation
@@ -41,6 +50,27 @@ Follow wiki documentation for installation process:
https://github.com/puppetlabs/Razor/wiki/installation
+## Project Committers
+
+This is the official list of users with "committer" rights to the
+Razor project. [For details on what that means, see the CONTRIBUTING
+guide in the repository][contrib]
+
+* [Daniel Pittman](https://github.com/daniel-pittman)
+* [Nicholas Weaver](https://github.com/lynxbat)
+* [Tom McSweeney](https://github.com/tjmcs)
+* [Nan Liu](https://github.com/nanliu)
+
+If you can't figure out who to contact,
+[Daniel Pittman](https://github.com/daniel-pittman) is the best first point of
+contact for the project. (Find me at Daniel Pittman <daniel@puppetlabs.com>,
+or dpittman on the `#puppet-razor` IRC channel.)
+
+This is a hand-maintained list, thanks to the limits of technology.
+Please let [Daniel Pittman](https://github.com/daniel-pittman) know if you run
+into any errors or omissions in that list.
+
+
## Razor MicroKernel
* The Razor MicroKernel project:
[https://github.com/puppetlabs/Razor-Microkernel](https://github.com/puppetlabs/Razor-Microkernel)
@@ -60,16 +90,6 @@ https://github.com/puppetlabs/Razor/wiki/installation
4 = Fatal
5 = Unknown
-## Directory structure
- ./bin - control scripts
- ./conf - configuration YAML files
- ./doc - Documentation (YARD)
- ./images - default images directory
- ./install - installation bits
- ./lib - root library folder
- ./test_scripts - testing scripts
- ./rspec - unit tests (RSpec)
-
## Starting services
Start Razor API with:
@@ -79,9 +99,18 @@ Start Razor API with:
## License
-See LICENSE file.
+Project Razor is distributed under the Apache 2.0 license.
+See [the LICENSE file][license] for full details.
## Reference
* Razor Overview: [Nickapedia.com](http://nickapedia.com/2012/05/21/lex-parsimoniae-cloud-provisioning-with-a-razor)
* Puppet Labs Razor Module:[Puppetlabs.com](http://puppetlabs.com/blog/introducing-razor-a-next-generation-provisioning-solution/)
+
+
+[puppet-razor]: https://groups.google.com/forum/?fromgroups#!forum/puppet-razor
+[irc]: https://webchat.freenode.net/?channels=puppet-razor
+[freenode]: http://freenode.net/
+[contrib]: https://github.com/puppetlabs/Razor/blob/master/CONTRIBUTING.md
+[license]: https://github.com/puppetlabs/Razor/blob/master/LICENSE
+[semver]: http://semver.org/
Oops, something went wrong.

0 comments on commit 1d31124

Please sign in to comment.