summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2018-09-29 07:07:04 -0700
committerSteve Piercy <web@stevepiercy.com>2018-09-29 07:07:04 -0700
commitadb5d1bea0e38549ecd71ff46156bdeb9db54b31 (patch)
tree7a1d9f3e18675c9624d262a6a5425b45118ca1e8
parentd589848b32ca1165da36c7c06804fcb9949a0cfa (diff)
downloadwebtest-adb5d1bea0e38549ecd71ff46156bdeb9db54b31.tar.gz
Add contributing.md
-rw-r--r--contributing.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/contributing.md b/contributing.md
new file mode 100644
index 0000000..d0be760
--- /dev/null
+++ b/contributing.md
@@ -0,0 +1,22 @@
+# 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/docs-style-guide/).
+
+You can contribute to this project in several ways.
+
+* [File an Issue on GitHub](https://github.com/Pylons/webtest/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).
+
+## Git Branches
+
+Git branches and their purpose and status at the time of this writing are listed below.
+
+* [master](https://github.com/Pylons/webtest/) - The branch which should always be *deployable*. The default branch on GitHub.
+* For development, create a new branch. If changes on your new branch are accepted, they will be merged into the master branch and deployed.
+
+## Prerequisites
+
+Follow the instructions in [README.rst](https://github.com/Pylons/webtest/) to install the tools needed to run the project.