-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #238 from mapswipe/dev
WIP: New Release 2.1.5
- Loading branch information
Showing
17 changed files
with
557 additions
and
399 deletions.
There are no files selected for viewing
This file contains 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 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 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 |
---|---|---|
@@ -1,12 +1,49 @@ | ||
# Contributing | ||
|
||
This document is a work progress. It should describe how to contribute (code or issues) to the MapSwipe back-end. | ||
|
||
To contribute to the MapSwipe back-end please create dedicated feature branches. | ||
## Clone from GitHub | ||
|
||
```bash | ||
git clone https://github.com/mapswipe/python-mapswipe-workers.git | ||
cd python-mapswipe-workers | ||
git checkout dev | ||
``` | ||
|
||
|
||
## Install MapSwipe Workers | ||
|
||
Create a Python virtual environment and activate it. Install MapSwipe Workers using pip: | ||
|
||
```bash | ||
python -m venv venv | ||
source venv/bin/activate | ||
pip install --editable . | ||
``` | ||
|
||
|
||
## Feature Branch | ||
|
||
To contribute to the MapSwipe back-end please create dedicated feature branches from dev: | ||
|
||
```bash | ||
git checkout dev | ||
git checkout -b featureA | ||
git commit -am 'add new project type' | ||
git push -u origin featureA | ||
git request-pull origin/master featureA | ||
git request-pull origin/dev featureA | ||
``` | ||
|
||
> Note: If a bug in production (master branch) needs fixing before a new versions of MapSwipe Workers gets released (merging dev into master branch), a hotfix branch should be created. In the hotfix branch the bug should be fixed and then merged back with master and also dev. | ||
|
||
## Style Guide | ||
|
||
This project uses [black](https://github.com/psf/black) and [flake8](https://gitlab.com/pycqa/flake8) to achieve a unified style. | ||
|
||
Use [pre-commit](https://pre-commit.com/) to run `black` and `flake8` prior to any git commit. `pre-commit`, `black` and `flake8` should already be installed in your virtual environment since they are listed in `requirements.txt`. To setup pre-commit simply run: | ||
|
||
``` | ||
pre-commit install | ||
``` | ||
|
||
From now on `black` and `flake8` should run automatically whenever `git commit` is executed. |
This file contains 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 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 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
Large diffs are not rendered by default.
Oops, something went wrong.
Oops, something went wrong.