Skip to content

Commit

Permalink
Update contributing documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Brett Swift authored and Brett Swift committed Sep 11, 2018
1 parent ceccddf commit 01f18d2
Showing 1 changed file with 18 additions and 50 deletions.
68 changes: 18 additions & 50 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,43 +4,12 @@
Contributing
============

Contributions are welcome, and they are greatly appreciated! Every little bit
helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions
----------------------

Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/brettswift/cumulus/issues.

If you are reporting a bug, please include:

* Your operating system name and version.
* Any details about your local setup that might be helpful in troubleshooting.
* Detailed steps to reproduce the bug.

Fix Bugs
~~~~~~~~

Look through the GitHub issues for bugs. Anything tagged with "bug" and "help
wanted" is open to whoever wants to implement it.

Implement Features
~~~~~~~~~~~~~~~~~~

Look through the GitHub issues for features. Anything tagged with "enhancement"
and "help wanted" is open to whoever wants to implement it.

Write Documentation
~~~~~~~~~~~~~~~~~~~

Cumulus could always use more documentation, whether as part of the
official Cumulus docs, in docstrings, or even on the web in blog posts,
articles, and such.
* Pull Requests Welcome
* use a feature branch: `feature/<name>`
* or a bugfix branch: `bugfix/<name>`
* squash commits
* write a good commit message https://chris.beams.io/posts/git-commit/
* Add your name to CONTRIBUTING.rst

Submit Feedback
~~~~~~~~~~~~~~~
Expand All @@ -64,17 +33,14 @@ Ready to contribute? Here's how to set up `cumulus` for local development.

$ git clone git@github.com:your_name_here/cumulus.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::
3. Install your local copy into a virtualenv. Assuming virtualenv and pyenv are installed,

$ mkvirtualenv cumulus
$ pyenv virtualenv 3.6 cumulus36
$ pyenv local cumulus36
$ cd cumulus/
$ python setup.py develop
$ python setup.py develop (sometimes I use `pip install -e .`)

4. Create a branch for local development::

$ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.
4. Create a branch, and code.

5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::
Expand All @@ -85,13 +51,15 @@ Ready to contribute? Here's how to set up `cumulus` for local development.

To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub::
6. Squash changes to a single commit and write a good commit message

* A good commit message follows: https://chris.beams.io/posts/git-commit/

$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
$ git fetch --all
$ git rebase -i [brettswift]/master
$ # use interactive squash to squash all commits (tip: keep the top one, type `s` or `squash` next to all the others

7. Submit a pull request through the GitHub website.
7. Push code and Submit a pull request through the GitHub website.

Pull Request Guidelines
-----------------------
Expand Down

0 comments on commit 01f18d2

Please sign in to comment.