Permalink
Browse files

Fixed some documentation

  • Loading branch information...
1 parent 7aa9605 commit cde19135eb41d7a8792ec9f57fe97f29a1a4689e @Idolf Idolf committed Aug 21, 2016
Showing with 10 additions and 5 deletions.
  1. +6 −1 CONTRIBUTING.md
  2. +3 −3 README.md
  3. +1 −1 setup.py
View
@@ -19,9 +19,14 @@ Finally, it is probably a good idea to run the test suite locally before doing
the pull-request to make sure everything works, however this is not a
requirement.
+Once you are ready to do a pull-request, you should figure out if your changes
+constitutes a new feature or a bugfix in stable or beta. If it is a bugfix in
+stable or beta, you should do the pull-request against the branch in question,
+and otherwise your pull-request should be against the dev branch.
+
Once you do the pull-request Travis CI will run the test-suite on it. Once it
passes one of the core developers will look at your pull request, possibly
-comment on it and then hopefully merge it into master.
+comment on it and then hopefully merge it into the branch in question.
## Automated Testing
View
@@ -1,12 +1,12 @@
# pwntools - CTF toolkit
-![pwntools logo](https://github.com/Gallopsled/pwntools/blob/master/docs/source/logo.png?raw=true)
+![pwntools logo](https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true)
[![Docs latest](https://readthedocs.org/projects/pwntools/badge/?version=latest)](https://pwntools.readthedocs.org/)
[![Docs 2.2.0](https://readthedocs.org/projects/pwntools/badge/?version=2.2.0)](https://pwntools.readthedocs.org/en/2.2.0)
[![PyPI](https://img.shields.io/pypi/v/pwntools.svg?style=flat)](https://pypi.python.org/pypi/pwntools/)
[![Gittip](https://img.shields.io/gittip/gallopsled.svg?style=flat)](https://www.gittip.com/gallopsled/)
-[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg?branch=master)](https://travis-ci.org/Gallopsled/pwntools)
-[![Coveralls](https://img.shields.io/coveralls/Gallopsled/pwntools/master.svg)](https://coveralls.io/github/Gallopsled/pwntools?branch=master)
+[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg?branch=stable)](https://travis-ci.org/Gallopsled/pwntools)
+[![Coveralls](https://img.shields.io/coveralls/Gallopsled/pwntools/stable.svg)](https://coveralls.io/github/Gallopsled/pwntools?branch=stable)
[![Twitter](https://img.shields.io/badge/twitter-pwntools-4099FF.svg?style=flat)](https://twitter.com/pwntools)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
View
@@ -79,7 +79,7 @@
author = "Zach Riggle",
author_email = "zachriggle@gmail.com",
url = 'https://pwntools.com',
- download_url = "https://pwntools.com/tarball/master",
+ download_url = "https://pwntools.com/tarball/stable",
install_requires = install_requires,
license = "Mostly MIT, some GPL/BSD, see LICENSE-pwntools.txt and LICENSE-pwntools.txt",
classifiers = [

0 comments on commit cde1913

Please sign in to comment.