From cde19135eb41d7a8792ec9f57fe97f29a1a4689e Mon Sep 17 00:00:00 2001 From: Mathias Svensson Date: Sat, 20 Aug 2016 18:19:07 -0700 Subject: [PATCH] Fixed some documentation --- CONTRIBUTING.md | 7 ++++++- README.md | 6 +++--- setup.py | 2 +- 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 02a008d31..b1470d477 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 diff --git a/README.md b/README.md index 198207f1d..6af4b0f81 100644 --- a/README.md +++ b/README.md @@ -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/) diff --git a/setup.py b/setup.py index 75f29696f..da4afd8ff 100644 --- a/setup.py +++ b/setup.py @@ -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 = [