Skip to content

Commit 1ef188b

Browse files
authored
Update CONTRIBUTING.md (#1893)
1 parent 964cf97 commit 1ef188b

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

.github/CONTRIBUTING.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -72,23 +72,22 @@ The basic workflow for contributing is:
7272
pip install -r requirements-dev.txt
7373
```
7474
6. In Python run `pre-commit install` to enable the commit hooks that run our linter.
75-
7. Install Chrome, download [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) and put it in the PATH.
76-
8. Make changes to your local copy of the folium repository
77-
9. Make sure the tests pass:
75+
7. Make changes to your local copy of the folium repository
76+
8. Make sure the tests pass:
7877
* in the repository folder do `pip install -e . --no-deps` (needed for notebook tests)
7978
* run `python -m pytest tests --ignore=tests/selenium`
8079
* run `python -m pytest tests/selenium`
8180
* resolve all errors
82-
10. Commit those changes
81+
9. Commit those changes
8382
```
8483
git add file1 file2 file3
8584
git commit -m 'a descriptive commit message'
8685
```
87-
11. Push your updated branch to your fork
86+
10. Push your updated branch to your fork
8887
```
8988
git push origin name-of-your-branch
9089
```
91-
12. [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
9291
9392
Since we're all volunteers please help us by making your PR easy to review. That means having a clear description and only touching code that's necessary for your change.
9493
@@ -117,8 +116,8 @@ The *final* PR should contain:
117116
- a new module in `folium/plugins` with the plugin class, with docstring
118117
- importing that class in `folium/plugins/__init__.py`
119118
- a test in `tests/plugins/test_[new plugin module].py`
120-
- an entry in the plugins gallery notebook `examples/Plugins.ipynb`
121-
- optionally, a separate example notebook to show more usage examples
119+
- listing the plugin in `docs/user_guide/plugins.rst`
120+
- a documentation module with examples in `docs/user_guide/plugins`
122121
123122
Before doing all this work it's a good idea to open a PR with just the plugin
124123
to discuss whether it's something to include in folium.

0 commit comments

Comments
 (0)