You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+7-8Lines changed: 7 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -72,23 +72,22 @@ The basic workflow for contributing is:
72
72
pip install -r requirements-dev.txt
73
73
```
74
74
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:
78
77
* in the repository folder do `pip install -e . --no-deps` (needed for notebook tests)
79
78
* run `python -m pytest tests --ignore=tests/selenium`
80
79
* run `python -m pytest tests/selenium`
81
80
* resolve all errors
82
-
10. Commit those changes
81
+
9. Commit those changes
83
82
```
84
83
git add file1 file2 file3
85
84
git commit -m 'a descriptive commit message'
86
85
```
87
-
11. Push your updated branch to your fork
86
+
10. Push your updated branch to your fork
88
87
```
89
88
git push origin name-of-your-branch
90
89
```
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
92
91
93
92
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.
94
93
@@ -117,8 +116,8 @@ The *final* PR should contain:
117
116
- a new module in `folium/plugins` with the plugin class, with docstring
118
117
- importing that class in `folium/plugins/__init__.py`
119
118
- 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`
122
121
123
122
Before doing all this work it's a good idea to open a PR with just the plugin
124
123
to discuss whether it's something to include in folium.
0 commit comments