|
| 1 | +# Contributing |
| 2 | + |
| 3 | +We love contributions! folium is open source, built on open source, |
| 4 | +and we'd love to have you hang out in our community. |
| 5 | + |
| 6 | +**Impostor syndrome disclaimer**: We want your help. No, really. |
| 7 | + |
| 8 | +There may be a little voice inside your head that is telling you that you're not |
| 9 | +ready to be an open source contributor; that your skills aren't nearly good |
| 10 | +enough to contribute. What could you possibly offer a project like this one? |
| 11 | + |
| 12 | +We assure you - the little voice in your head is wrong. If you can write code at |
| 13 | +all, you can contribute code to open source. Contributing to open source |
| 14 | +projects is a fantastic way to advance one's coding skills. Writing perfect code |
| 15 | +isn't the measure of a good developer (that would disqualify all of us!); it's |
| 16 | +trying to create something, making mistakes, and learning from those |
| 17 | +mistakes. That's how we all improve, and we are happy to help others learn. |
| 18 | + |
| 19 | +Being an open source contributor doesn't just mean writing code, either. You can |
| 20 | +help out by writing documentation, tests, or even giving feedback about the |
| 21 | +project (and yes - that includes giving feedback about the contribution |
| 22 | +process). Some of these contributions may be the most valuable to the project as |
| 23 | +a whole, because you're coming to the project with fresh eyes, so you can see |
| 24 | +the errors and assumptions that seasoned contributors have glossed over. |
| 25 | + |
| 26 | +(This disclaimer was originally written by |
| 27 | +[Adrienne Lowe](https://github.com/adriennefriend) for a |
| 28 | +[PyCon talk](https://www.youtube.com/watch?v=6Uj746j9Heo), and was adapted by folium |
| 29 | +based on its use in the README file for the |
| 30 | +[yt project](https://github.com/yt-project/yt/blob/master/README.md)) |
| 31 | + |
| 32 | +## Usage questions |
| 33 | + |
| 34 | +The best place to submit questions about how to use folium is via the |
| 35 | +[gitter](https://gitter.im/python-visualization/folium) channel. |
| 36 | +Usage question in the issue tracker will probably go unanswered. |
| 37 | + |
| 38 | +## Reporting issues |
| 39 | + |
| 40 | +When reporting issues please include as much detail as possible regarding the folium and python version, use of notebooks, etc. |
| 41 | +Whenever possible, please also include a [short, self-contained code example](http://sscce.org) that demonstrates the problem. |
| 42 | + |
| 43 | +## Contributing code |
| 44 | + |
| 45 | +First of all, thanks for your interest in contributing! |
| 46 | + |
| 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 [email protected]:${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. Commit those changes |
| 62 | + ``` |
| 63 | + git add file1 file2 file3 |
| 64 | + git commit -m 'a descriptive commit message' |
| 65 | + ``` |
| 66 | + 6. Push your updated branch to your fork |
| 67 | + ``` |
| 68 | + git push origin name-of-your-branch |
| 69 | + ``` |
| 70 | + 7. [Open a pull request](https://help.github.com/articles/creating-a-pull-request/) to the python-visualization/folium |
0 commit comments