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
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,28 +71,28 @@ The basic workflow for contributing is:
71
71
pip install -r requirements.txt
72
72
pip install -r requirements-dev.txt
73
73
```
74
-
6. Install Chrome, download [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) and put it in the PATH.
75
-
7. Make changes to your local copy of the folium repository
76
-
8. Make sure the tests pass:
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:
77
78
* in the repository folder do `pip install -e . --no-deps` (needed for notebook tests)
78
-
* run `flake8 folium --max-line-length=120`
79
79
* run `python -m pytest tests --ignore=tests/selenium`
80
80
* run `python -m pytest tests/selenium`
81
81
* resolve all errors
82
-
9. Commit those changes
83
-
```
84
-
git add file1 file2 file3
85
-
git commit -m 'a descriptive commit message'
86
-
```
87
-
10. Push your updated branch to your fork
82
+
10. Commit those changes
83
+
```
84
+
git add file1 file2 file3
85
+
git commit -m 'a descriptive commit message'
86
+
```
87
+
11. Push your updated branch to your fork
88
88
```
89
89
git push origin name-of-your-branch
90
90
```
91
-
11.[Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the python-visualization/folium
91
+
12. [Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the python-visualization/folium
92
92
93
93
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
94
95
-
## Plugin acceptence criteria
95
+
## Plugin acceptance criteria
96
96
97
97
If you have a Leaflet plugin you would like to include in folium's plugins, please
98
98
check these criteria to see if it's a good candidate.
0 commit comments