Skip to content
This repository has been archived by the owner on Nov 5, 2019. It is now read-only.

Commit

Permalink
Moving CONTRIBUTING out of docs to repository top-level.
Browse files Browse the repository at this point in the history
Unifying the old docs/contributing.rst with the current
contents of CONTRIBUTING.md.
  • Loading branch information
dhermes committed Aug 7, 2015
1 parent dc0dd28 commit a97beba
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 69 deletions.
44 changes: 41 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,44 @@
Contributing
============

1. **Please sign one of the contributor license agreements below.**
1. Fork the repo, develop and test your code changes, add docs.
1. **Please sign one of the contributor license agreements [below][6].**
1. [File an issue][9] to notify the maintainers about what you're working on.
1. [Fork the repo][10], develop and [test][11] your code changes, add docs.
1. Make sure that your commit messages clearly describe the changes.
1. Send a pull request.
1. [Send][12] a pull request.

Here are some guidelines for hacking on `oauth2client`.

Before writing code, file an issue
----------------------------------

Use the [issue tracker][7] to start the discussion. It is possible that someone
else is already working on your idea, your approach is not quite right, or that
the functionality exists already. The ticket you file in the issue tracker will
be used to hash that all out.

Fork `oauth2client`
-------------------

We will use GitHub's mechanism for [forking][8] repositories and making pull
requests. Fork the repository, and make your changes in the forked repository.

Include tests
-------------

Be sure to add the relevant tests before making the pull request. Docs will be
updated automatically when we merge to `master`, but you should also build
the docs yourself via `tox -e docs` and make sure they're readable.

Make the pull request
---------------------

Once you have made all your changes, tests, and updated the documentation,
make a pull request to move everything back into the main `oauth2client`
repository. Be sure to reference the original issue in the pull request.
Expect some back-and-forth with regards to style and compliance of these
rules.

Using a Development Checkout
----------------------------

Expand Down Expand Up @@ -153,3 +184,10 @@ we'll be able to accept your pull requests.
[3]: https://cloud.google.com/storage/docs/authentication#generating-a-private-key
[4]: https://developers.google.com/open-source/cla/individual
[5]: https://developers.google.com/open-source/cla/corporate
[6]: #contributor-license-agreements
[7]: https://github.com/google/oauth2client/issues
[8]: https://help.github.com/articles/fork-a-repo/
[9]: #before-writing-code-file-an-issue
[10]: #fork-oauth2client
[11]: #include-tests
[12]: #make-the-pull-request
21 changes: 11 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,29 @@
[![Build Status](https://travis-ci.org/google/oauth2client.svg?branch=master)](https://travis-ci.org/google/oauth2client)

[![Coverage Status](https://img.shields.io/coveralls/google/oauth2client.svg)](https://coveralls.io/r/google/oauth2client?branch=master)
[![Documentation Status](https://readthedocs.org/projects/oauth2client/badge/?version=latest)](http://oauth2client.readthedocs.org/)

This is a client library for accessing resources protected by OAuth 2.0.

[Full documentation](http://google.github.io/oauth2client/)

Installation
============

To install, simply say

$ pip install --upgrade oauth2client
```bash
$ pip install --upgrade oauth2client
```

Contributing
============

Please see the
[contributing page](http://google.github.io/oauth2client/contributing.html)
for more information. In particular, we love pull requests -- but please make
sure to sign the contributor license agreement.
Please see the [CONTRIBUTING page][1] for more information. In particular, we
love pull requests -- but please make sure to sign the contributor license
agreement.

Supported Python Versions
=========================

We support Python 2.6, 2.7, 3.3+. More information
[in the docs](http://google.github.io/oauth2client/#supported-python-versions).
We support Python 2.6, 2.7, 3.3+. More information [in the docs][2].

[1]: https://github.com/google/oauth2client/blob/master/CONTRIBUTING.md
[2]: http://oauth2client.readthedocs.org/#supported-python-versions
54 changes: 0 additions & 54 deletions docs/contributing.rst

This file was deleted.

5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,16 +40,17 @@ Library Documentation
Contributing
------------

Please see the `contributing page <contributing.html>`_ for more information.
Please see the `contributing page`_ for more information.
In particular, we love pull requests -- but please make sure to sign the
contributor license agreement.

.. _contributing page: https://github.com/google/oauth2client/blob/master/CONTRIBUTING.md

.. toctree::
:maxdepth: 1
:hidden:

source/modules
contributing

Supported Python Versions
-------------------------
Expand Down

0 comments on commit a97beba

Please sign in to comment.