Skip to content

Commit

Permalink
Update contribution guidelines for maitanence
Browse files Browse the repository at this point in the history
  • Loading branch information
kyleknap committed Aug 19, 2015
1 parent c9a4f36 commit 1b545b5
Showing 1 changed file with 45 additions and 0 deletions.
45 changes: 45 additions & 0 deletions CONTRIBUTING
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,48 @@ Reporting An Issue/Feature
resolved sooner.


Maintenance
===========

You do not have to be labeled as a
"mainatainer" to be able to help with the triaging, resolving, and
reviewing of boto issues and pull requests.

These are the processes that the maintainers follow, that you can also
follow to help speed up the resolution of an issue or pull request:

Pull Requests
-------------
There are some key points that are needed to be met before a pull request
can be merged:

* All tests must pass for all python versions.
* All pull requests require tests that either test the new feature or test
that the specific bug is fixed. Pull requests for minor things like
adding a new region or fixing a typo do not need tests.
* Must follow PEP8 conventions.
* All changes must be backwards compatible.
* If the pull request is for a feature, make sure a link to the corresponding
API is provided in order to easily check that the feature matches up
with the service's API.

The best way to help with pull requests is to comment on pull requests by
noting if any of these key points are missing, it will both help get feedback
sooner to the issuer of the pull request and make it easier to determine for
an individual with write permissions to the repository if a pull request
is ready to be merged.

Issues
------
Here are the best ways to help with open issues:

* If there is an issue without a set of instructions on how to reproduce the
bug, feel free to try to reproduce the issue, comment with the minimal
amount of steps to reproduce the bug (a code snippet would be ideal). If
there is not a set of steps that can be made to reproduce the issue, at
least make sure there are debug logs that capture the unexpected behavior.

* Consolidate all related issue to one issues by closing out related issues
and linking them to the single issue that outlines the general issue.

* Submit pull requests for open issues.

0 comments on commit 1b545b5

Please sign in to comment.