@@ -44,31 +44,37 @@ Whenever possible, please also include a [short, self-contained code example](ht
4444
4545First of all, thanks for your interest in contributing!
4646
47- - If you are new to git/Github, please take check a few tutorials
48- on [ git] ( https://git-scm.com/docs/gittutorial ) and [ GitHub] ( https://guides.github.com/ ) .
49- - The basic workflow for contributing is:
50- 1 . [ Fork] ( https://help.github.com/articles/fork-a-repo/ ) the repository
51- 2 . [ Clone] ( https://help.github.com/articles/cloning-a-repository/ ) the repository to create a local copy on your computer:
52- ```
53- git clone git@github.com:${user}/folium.git
54- cd folium
55- ```
56- 3. Create a branch for your changes
57- ```
58- git checkout -b name-of-your-branch
59- ```
60- 4. Make change to your local copy of the folium repository
61- 5. Make sure the tests pass:
62- * in the repository folder do `pip install -e .` (needed for notebook tests)
63- * run `python -m pytest tests`
64- * resolve all errors
65- 6. Commit those changes
66- ```
67- git add file1 file2 file3
68- git commit -m 'a descriptive commit message'
69- ```
70- 7. Push your updated branch to your fork
71- ```
72- git push origin name-of-your-branch
73- ```
74- 8. [Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the python-visualization/folium
47+ If you are new to git/Github, please take check a few tutorials
48+ on [ git] ( https://git-scm.com/docs/gittutorial ) and [ GitHub] ( https://guides.github.com/ ) .
49+
50+ The basic workflow for contributing is:
51+
52+ 1 . [ Fork] ( https://help.github.com/articles/fork-a-repo/ ) the repository
53+ 2 . [ Clone] ( https://help.github.com/articles/cloning-a-repository/ ) the repository to create a local copy on your computer:
54+ ```
55+ git clone git@github.com:${user}/folium.git
56+ cd folium
57+ ```
58+ 3 . Create a branch for your changes
59+ ```
60+ git checkout -b name-of-your-branch
61+ ```
62+ 4 . Install the dependencies listed in ` requirements.txt ` and ` requirements-dev.txt ` .
63+ 5 . Install Firefox, download [ geckodriver] ( https://github.com/mozilla/geckodriver/releases )
64+ and put it in the PATH.
65+ 6 . Make changes to your local copy of the folium repository
66+ 7 . Make sure the tests pass:
67+ * in the repository folder do ` pip install -e . ` (needed for notebook tests)
68+ * run ` python -m pytest tests `
69+ * run ` flake8 folium --max-line-length=120 `
70+ * resolve all errors
71+ 8 . Commit those changes
72+ ```
73+ git add file1 file2 file3
74+ git commit -m 'a descriptive commit message'
75+ ```
76+ 9 . Push your updated branch to your fork
77+ ```
78+ git push origin name-of-your-branch
79+ ```
80+ 10 . [ Open a pull request] ( https://help.github.com/articles/creating-a-pull-request/ ) to the python-visualization/folium
0 commit comments