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: CONTRIBUTING.md
+12-1
Original file line number
Diff line number
Diff line change
@@ -94,7 +94,18 @@ Once forked, use the following steps to get your development environment set up
94
94
$ pip install -r docs/requirements.txt
95
95
```
96
96
97
-
4. Switch to the develop branch.
97
+
4. (Optional) Set up pre-commit hooks.
98
+
99
+
When opening a PR in the Yellowbrick repository, a series of checks will be run on your contribution, some of which lint and look at the formatting of your code. These may indicate some changes that need to be made before your contribution can be reviewed. You can set up pre-commit hooks to run these checks locally upon running `git commit` to ensure your contribution will pass formatting and linting checks. To set this up, you will need to uncomment the pre-commit line in `requirements.txt` and then run the following commands:
100
+
101
+
```
102
+
$ pip install -r requirements.txt
103
+
$ pre-commit install
104
+
```
105
+
106
+
The next time you run `git commit` in the Yellowbrick repository, the checks will automatically run.
107
+
108
+
5. Switch to the develop branch.
98
109
99
110
The Yellowbrick repository has a `develop` branch that is the primary working branch for contributions. It is probably already the branch you're on, but you can make sure and switch to it as follows::
Copy file name to clipboardexpand all lines: docs/contributing/getting_started.rst
+14-5
Original file line number
Diff line number
Diff line change
@@ -19,7 +19,7 @@ We believe that *contribution is collaboration* and therefore emphasize *communi
19
19
20
20
Once you have a good sense of how you are going to implement the new feature (or fix the bug!), you can reach out for feedback from the maintainers by creating a `pull request <https://github.com/DistrictDataLabs/yellowbrick/pulls>`_. Ideally, any pull request should be capable of resolution within 6 weeks of being opened. This timeline helps to keep our pull request queue small and allows Yellowbrick to maintain a robust release schedule to give our users the best experience possible. However, the most important thing is to keep the dialogue going! And if you're unsure whether you can complete your idea within 6 weeks, you should still go ahead and open a PR and we will be happy to help you scope it down as needed.
21
21
22
-
If we have comments or questions when we evaluate your pull request and receive no response, we will also close the PR after this period of time. Please know that this does not mean we don't value your contribution, just that things go stale. If in the future you want to pick it back up, feel free to address our original feedback and to reference the original PR in a new pull request.
22
+
If we have comments or questions when we evaluate your pull request and receive no response, we will also close the PR after this period of time. Please know that this does not mean we don't value your contribution, just that things go stale. If in the future you want to pick it back up, feel free to address our original feedback and to reference the original PR in a new pull request.
23
23
24
24
.. note:: Please note that if we feel your solution has not been thought out in earnest, or if the PR is not aligned with our `current milestone <https://github.com/districtdatalabs/yellowbrick/milestones>`_ goals, we may reach out to ask that you close the PR so that we can prioritize reviewing the most critical feature requests and bug fixes.
25
25
@@ -54,22 +54,31 @@ Once forked, use the following steps to get your development environment set up
54
54
$ pip install -e .
55
55
56
56
This will add Yellowbrick to your PYTHONPATH so that you don't need to reinstall it each time you make a change during development.
57
-
57
+
58
58
Note that there may be other dependencies required for development and testing; you can simply install them with ``pip``. For example to install
59
59
the additional dependencies for building the documentation or to run the
60
60
test suite, use the ``requirements.txt`` files in those directories::
61
61
62
62
$ pip install -r tests/requirements.txt
63
63
$ pip install -r docs/requirements.txt
64
64
65
-
4. Switch to the develop branch.
65
+
4. (Optional) Set up pre-commit hooks.
66
+
67
+
When opening a PR in the Yellowbrick repository, a series of checks will be run on your contribution, some of which lint and look at the formatting of your code. These may indicate some changes that need to be made before your contribution can be reviewed. You can set up pre-commit hooks to run these checks locally upon running ``git commit`` to ensure your contribution will pass formatting and linting checks. To set this up, you will need to uncomment the pre-commit line in ``requirements.txt`` and then run the following commands::
68
+
69
+
$ pip install -r requirements.txt
70
+
$ pre-commit install
71
+
72
+
The next time you run ``git commit`` in the Yellowbrick repository, the checks will automatically run.
73
+
74
+
5. Switch to the develop branch.
66
75
67
76
The Yellowbrick repository has a ``develop`` branch that is the primary working branch for contributions. It is probably already the branch you're on, but you can make sure and switch to it as follows::
68
77
69
78
$ git fetch
70
79
$ git checkout develop
71
80
72
-
At this point you're ready to get started writing code.
81
+
At this point you're ready to get started writing code.
73
82
74
83
Branching Convention
75
84
--------------------
@@ -89,7 +98,7 @@ We also recommend setting up an ``upstream`` remote so that you can easily pull
0 commit comments