Skip to content
This repository has been archived by the owner on Mar 23, 2020. It is now read-only.

Commit

Permalink
[docs] contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
xeroc committed Jan 16, 2017
1 parent 9acfc5e commit c9346d0
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 0 deletions.
1 change: 1 addition & 0 deletions CONTRIBUTING
@@ -0,0 +1 @@
Please read ``docs/contribute.rst``.
49 changes: 49 additions & 0 deletions docs/contribute.rst
@@ -0,0 +1,49 @@
Contributing to python-steem
============================

We welcome your contributions to our project.

Flow
----

This project makes heavy use of [git flow](http://nvie.com/posts/a-successful-git-branching-model/).
If you are not familiar with it, then the most important thing for your
to understand is that:

pull requests need to be made against the develop branch

How to Contribute
-----------------

0. Familiarize yourself with [contributing on github](https://guides.github.com/activities/contributing-to-open-source/)
1. Fork or branch from the master.
2. Create commits following the commit style
3. Start a pull request to the master branch
4. Wait for a @xeroc or another member to review

Issues
------

Feel free to submit issues and enhancement requests.

Contributing
------------

Please refer to each project's style guidelines and guidelines for
submitting patches and additions. In general, we follow the
"fork-and-pull" Git workflow.

1. **Fork** the repo on GitHub
2. **Clone** the project to your own machine
3. **Commit** changes to your own branch
4. **Push** your work back up to your fork
5. Submit a **Pull request** so that we can review your changes

NOTE: Be sure to merge the latest from "upstream" before making a pull
request!

Copyright and Licensing
-----------------------

This library is open sources under the MIT license. We require your to
release your code under that license as well.
1 change: 1 addition & 0 deletions docs/index.rst
Expand Up @@ -23,6 +23,7 @@ Getting Started
installation
quickstart
tutorials
contribute


Python-Steem Libraries
Expand Down

0 comments on commit c9346d0

Please sign in to comment.