summaryrefslogtreecommitdiff
path: root/contributing.md
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2018-11-26 20:50:29 +0900
committerChris Dent <chris.dent@gmail.com>2018-11-26 11:50:29 +0000
commit48b644a84dbfde2b4581bd7bed340cffe566b2af (patch)
treebea6ad6df7adb828e64c78ba1ffd67d046b181ff /contributing.md
parentff81a47051c40a3998b0844ee130ec67e01a0b4b (diff)
downloadpastedeploy-git-48b644a84dbfde2b4581bd7bed340cffe566b2af.tar.gz
Add contributing.md (#12)
* Add contributing.md - Closes #7 * Use proper tox commands
Diffstat (limited to 'contributing.md')
-rw-r--r--contributing.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 0000000..4dca72d
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,26 @@
+# Contributing
+
+All projects under the Pylons Project, including this one, follow the guidelines established at [How to Contribute](https://pylonsproject.org/community-how-to-contribute.html), [Coding Style and Standards](https://pylonsproject.org/community-coding-style-standards.html), and [Pylons Project Documentation Style Guide](https://docs.pylonsproject.org/projects/pastedeploy/).
+
+You can contribute to this project in several ways.
+
+* [File an Issue on GitHub](https://github.com/Pylons/pastedeploy/issues)
+* Fork this project, create a new branch, commit your suggested change, and push to your fork on GitHub.
+ When ready, submit a pull request for consideration.
+ [GitHub Flow](https://guides.github.com/introduction/flow/index.html) describes the workflow process and why it's a good practice.
+* Join the [IRC channel #pyramid on irc.freenode.net](https://webchat.freenode.net/?channels=pyramid).
+
+
+## Running Tests and Building Docs
+
+Run `tox` from within your checkout. This will run the tests across all supported systems and attempt to build the docs.
+
+To run the tests for Python 3.7 only:
+
+ $ tox -e py37
+
+To build the docs:
+
+ $ tox -e docs
+
+See the `tox.ini` file for details.