Skip to content

Commit 76cefeb

Browse files
committed
Write a new documentation page with branch info
This is related to #1352. Once this PR is merged we should: - Change github default branch to `dev` - Delete `master` - Confirm that read the docs is looking at `release` Am I missing anything? We should also remove the release process information from the wiki (assuming we're happy with what I've written here). Finally, once #1360 is done we should make sure we update the docs with the relevant information.
1 parent bf42a8b commit 76cefeb

File tree

2 files changed

+33
-0
lines changed

2 files changed

+33
-0
lines changed

docs/tutorials/contributing/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ Contents:
1010
:maxdepth: 2
1111

1212
guidelines.rst
13+
setting_up_the_environment.rst
1314
strategy/index.rst
1415
library/index.rst
1516
running_tests.rst
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
Setting up the environment
2+
==========================
3+
4+
Installing all dependencies
5+
---------------------------
6+
7+
All testing dependencies can be installed by running::
8+
9+
$ pip install -r requirements.txt
10+
11+
It is recommended to do this using a virtual environment tool of your choice.
12+
13+
The git workflow
14+
----------------
15+
16+
There are two important branches in this repository:
17+
18+
- :code:`dev`: The most up to date branch with no failing tests.
19+
This is the default branch on github.
20+
- :code:`release`: The latest release.
21+
22+
When working on a new contribution branch from the latest :code:`dev` branch and
23+
open a Pull Request on github from your branch to the :code:`dev` branch.
24+
25+
The procedure for a new release (this is carried out by one of core maintainers):
26+
27+
1. Create a Pull Request from :code:`dev` to :code:`release` which should
28+
include an update to :code:`axelrod/version.py` and :code:`CHANGES.md`
29+
2. Create a git tag.
30+
3. Push to github.
31+
4. Create a release on github.
32+
5. Push to PyPi: :code:`python setup.py sdist bdist_wheel upload`

0 commit comments

Comments
 (0)