contributing

rasbt · Jan 26, 2015 · fd00419 · fd00419
1 parent bb57159
commit fd00419
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,41 @@
+# How to Contribute
+
+I would be very happy about any kind of contributions that help to improve and extend the functionality of pyprind.
+
+<br>
+<br>
+
+
+## Getting Started
+
+- If you don't have a [GitHub](https://github.com) account yet, please create one to contribute to this project.
+- Please submit a ticket for your issue to discuss the fix or new feature before too much time and effort is spent for the implementation.
+
+![](./images/contributing/new_issue.png)
+
+- Fork the `pyprind` repository from the GitHub web interface.
+
+![](./images/contributing/fork.png)
+
+- Clone the `pyprind` repository to your local machine
+	- `git clone https://github.com/your_username/pyprind.git`
+
+<br>
+<br>
+
+## Making Changes
+
+- Please avoid working directly on the master branch but create a new feature branch:
+	- `git branch new_feature`
+	- `git checkout new_feature`
+- When you make changes, please provide meaningful `commit` messages:
+	- `git add edited_file` 
+	- `git commit -m 'my note'` 
+- If it is a new feature, it would be nice (but not necessary) if you could update the documentation.
+- Make an entry in the `CHANGELOG.md` file.
+- Add tests to the `pyprind/tests` directory.
+- Run all tests (e.g., via `nosetests`  or `pytest`).
+- Push your changes to a topic branch:
+	- `git push -u origin my_feature`
+- Submit a `pull request` from your forked repository via the GitHub web interface.
+![](./images/contributing/pull_request.png)
diff --git a/images/contributing/fork.png b/images/contributing/fork.png
diff --git a/images/contributing/new_issue.png b/images/contributing/new_issue.png
diff --git a/images/contributing/pull_request.png b/images/contributing/pull_request.png