-
Notifications
You must be signed in to change notification settings - Fork 274
Write a new documentation page with branch info #1367
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Nikoleta-v3
merged 7 commits into
dev
from
update-contribution-documentation-for-new-branches
Sep 9, 2020
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
76cefeb
Write a new documentation page with branch info
drvinceknight 5cd6f3a
Remove ambiguous `very`.
drvinceknight 917eead
Remove hypothesis version specification in docs.
drvinceknight 3f60d5d
Test properties not affected by floating point error
drvinceknight 95e2905
Add instructions for using venv.
drvinceknight dd07cdc
s/requirements/requirements.txt
drvinceknight f88bfc6
Spell requirements correctly..
drvinceknight File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
38 changes: 38 additions & 0 deletions
38
docs/tutorials/contributing/setting_up_the_environment.rst
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
Setting up the environment | ||
========================== | ||
|
||
Installing all dependencies | ||
--------------------------- | ||
|
||
All dependencies can be installed by running:: | ||
|
||
$ pip install -r requirements.txt | ||
|
||
It is recommended to do this using a virtual environment tool of your choice. | ||
|
||
For example, when using the virtual environment library :code:`venv`:: | ||
|
||
$ python -m venv axelrod_development | ||
$ source axelrod_development/bin/activate | ||
$ pip install -r requirements.txt | ||
|
||
The git workflow | ||
---------------- | ||
|
||
There are two important branches in this repository: | ||
|
||
- :code:`dev`: The most up to date branch with no failing tests. | ||
This is the default branch on github. | ||
- :code:`release`: The latest release. | ||
|
||
When working on a new contribution branch from the latest :code:`dev` branch and | ||
open a Pull Request on github from your branch to the :code:`dev` branch. | ||
|
||
The procedure for a new release (this is carried out by one of core maintainers): | ||
|
||
1. Create a Pull Request from :code:`dev` to :code:`release` which should | ||
include an update to :code:`axelrod/version.py` and :code:`CHANGES.md` | ||
2. Create a git tag. | ||
3. Push to github. | ||
4. Create a release on github. | ||
5. Push to PyPi: :code:`python setup.py sdist bdist_wheel upload` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.