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
- Now, `git remote -v` will show two remote repositories named:
16
+
- upstream, which refers to the scikit-plot repository
17
+
- origin, which refers to your personal fork
18
+
- Pull the latest changes from upstream, including tags:
19
+
```bash
20
+
git checkout main
21
+
git pull upstream main --tags
22
+
```
23
+
- Initialize submodules:
24
+
```bash
25
+
git submodule update --init
26
+
```
9
27
3. **Run the tests** to make sure they pass on your machine. Simply run `pytest` at the root folder and make sure all tests pass.
10
28
11
29
4. **Create a new branch**. Please do not commit directly to the master branch. Create your own branch and place your additions there.
12
30
13
-
5.**Write your code**. Please follow PEP8 coding standards. Also, if you're adding a function, you must [write a docstring using the Google format](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) detailing the API of your function. Take a look at the docstrings of the other Scikit-plot functions to get an idea of what the docstring of yours should look like.
31
+
- Develop your contribution:
32
+
- Create a branch forthe feature you want to work on. Since the branch name will appearin the merge message, use a sensible name such as 'linspace-speedups':
33
+
```bash
34
+
git checkout -b linspace-speedups
35
+
```
36
+
5. **Write your code**. Please follow PEP8 coding standards. Also, if you're adding a function, you must currently [write a docstring using the Google format](http://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) detailing the API of your function or In Feature [NumPy docstring standard](https://numpy.org/devdocs/dev/howto-docs.html#howto-document). Take a look at the docstrings of the other Scikit-plot functions to get an idea of what the docstring of yours should look like.
37
+
38
+
- Commit locally as you progress (`git add` and `git commit`) Use a properly formatted commit message, write tests that fail before your change and pass afterward, run all the tests locally. Be sure to document any changed behavior in docstrings, keeping to the NumPy docstring [standard](https://numpy.org/devdocs/dev/howto-docs.html#howto-document).
14
39
15
40
6. **Write/modify the corresponding unit tests**. After adding in your code and the corresponding unit tests, run `pytest` again to make sure they pass.
16
41
17
-
7.**Submit a pull request**. After submitting a PR, if all tests pass, your code will be reviewed and merged promptly.
42
+
7. **Submit a pull request**. After submitting a PR (pull requests), if all tests pass, your code will be reviewed and merged promptly.
43
+
44
+
- To submit your contribution:
45
+
- Push your changes back to your fork on GitHub:
46
+
```bash
47
+
git push origin linspace-speedups
48
+
```
49
+
- Go to GitHub. The new branch will show up with a green Pull Request button. Make sure the title and message are clear, concise, and self- explanatory. Then click the button to submit it.
50
+
51
+
- If your commit introduces a new feature or changes functionality, post on the mailing list to explain your changes. For bug fixes, documentation updates, etc., this is generally not necessary, though if you do not get any reaction, do feel free to ask for review.
52
+
- Review process:
18
53
19
54
Thank you for taking the time to make Scikit-plot better!
0 commit comments