Skip to content

Commit 8bcb688

Browse files
committed
Merge pull request #8 from python-visualization/master
Update master branch
1 parent 801c4c9 commit 8bcb688

File tree

1 file changed

+14
-8
lines changed

1 file changed

+14
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,26 +59,32 @@ The basic workflow for contributing is:
5959
```
6060
git checkout -b name-of-your-branch
6161
```
62-
4. Install the dependencies listed in `requirements.txt` and `requirements-dev.txt`.
62+
4. Install the [miniconda](https://docs.conda.io/en/latest/miniconda.html) to avoid any external library errors.
63+
64+
If using `conda` one can create a development environment with:
65+
```
66+
$ conda create --name FOLIUM python=3.7 --file requirements.txt --file requirements-dev.txt
67+
```
68+
5. Install the dependencies listed in `requirements.txt` and `requirements-dev.txt`.
6369
```
6470
pip install -r requirements.txt
6571
pip install -r requirements-dev.txt
6672
```
67-
5. Install Firefox, download [geckodriver](https://github.com/mozilla/geckodriver/releases)
73+
6. Install Firefox, download [geckodriver](https://github.com/mozilla/geckodriver/releases)
6874
and put it in the PATH.
69-
6. Make changes to your local copy of the folium repository
70-
7. Make sure the tests pass:
71-
* in the repository folder do `pip install -e .` (needed for notebook tests)
75+
7. Make changes to your local copy of the folium repository
76+
8. Make sure the tests pass:
77+
* in the repository folder do `pip install -e . --no-deps` (needed for notebook tests)
7278
* run `python -m pytest tests`
7379
* run `flake8 folium --max-line-length=120`
7480
* resolve all errors
75-
8. Commit those changes
81+
9. Commit those changes
7682
```
7783
git add file1 file2 file3
7884
git commit -m 'a descriptive commit message'
7985
```
80-
9. Push your updated branch to your fork
86+
10. Push your updated branch to your fork
8187
```
8288
git push origin name-of-your-branch
8389
```
84-
10. [Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the python-visualization/folium
90+
11. [Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the python-visualization/folium

0 commit comments

Comments
 (0)