|
1 |
| -### Welcome, Contributor! |
2 |
| -This template is meant to get your PR started off on the right foot. |
| 1 | +<!-- |
| 2 | +# Welcome Contributor! |
3 | 3 |
|
4 |
| -### I. Are you merging from a feature branch into develop? |
5 |
| -_If not, please create a feature branch and change your PR to merge from that branch into Yellowbrick `develop`._ |
| 4 | +Thank you for contributing to Yellowbrick, please follow the instructions below to get |
| 5 | +your PR started off on the right foot. |
6 | 6 |
|
7 |
| -### II. Does your PR have a title? |
8 |
| -_Please ensure your PR has a short, informative title, e.g. "Enhances ParallelCoordinates with new andrews_curve parameter" or "Corrects bug in WhiskerPlot that causes index error"_ |
| 7 | +## First Steps |
| 8 | +
|
| 9 | +1. Are you merging from a feature branch into develop? |
| 10 | +
|
| 11 | + _If not, please create a feature branch and change your PR to merge from that branch |
| 12 | + into the Yellowbrick `develop` branch._ |
| 13 | +
|
| 14 | +2. Does your PR have a title? |
| 15 | +
|
| 16 | + _Please ensure your PR has a short, informative title, e.g. "Enhances ParallelCoordinates with new andrews_curve parameter" or "Corrects bug in WhiskerPlot that causes index error"_ |
| 17 | +
|
| 18 | +3. Summarize your PR (HINT: See CHECKLIST/TEMPLATE below!) |
| 19 | +--> |
9 | 20 |
|
10 |
| -### III. Summarize your PR (HINT: See CHECKLIST below!) |
11 | 21 | This PR fixes #issue_number _(If you are fixing a bug)_ which reported a bug that caused a problem to occur when users...
|
| 22 | + |
12 | 23 | _(or if you are introducing a new feature)_ which requested a feature to allow the user to...
|
13 | 24 |
|
14 |
| -I have made the following changes |
15 |
| -1. |
16 |
| -2. |
17 |
| -3. |
| 25 | +I have made the following changes: |
| 26 | + |
| 27 | +1. |
| 28 | +2. |
| 29 | +3. |
18 | 30 |
|
19 |
| -### IV. Include a sample plot |
20 |
| -_If you are adding or modifying a visualizer, PLEASE include a sample plot here._ |
| 31 | +### Sample Code and Plot |
21 | 32 |
|
22 |
| -### V. List any TODOs or questions |
23 |
| -_If this is a work-in-progress (WIP), list the changes you still need to make and/or questions or the Yellowbrick team:_ |
| 33 | +_If you are adding or modifying a visualizer, PLEASE include a sample plot here along with the code you used to generate it._ |
| 34 | + |
| 35 | +### TODOs and questions |
| 36 | + |
| 37 | +<!-- |
| 38 | +If this is a work-in-progress (WIP), list the changes you still need to make and/or questions or the Yellowbrick team. You can also mention extensions to your work that might be added as an issue to work on after the PR. |
| 39 | +--> |
24 | 40 |
|
25 | 41 | Still to do:
|
26 |
| -- [ ] |
27 |
| -- [ ] |
28 |
| -- [ ] |
| 42 | + |
| 43 | +- [ ] |
| 44 | +- [ ] |
| 45 | +- [ ] |
29 | 46 |
|
30 | 47 | Questions for the @DistrictDataLabs/team-oz-maintainers:
|
31 |
| -- [ ] |
32 |
| -- [ ] |
33 | 48 |
|
34 |
| -### VI. CHECKLIST |
35 |
| -_Here's a handy checklist to go through before submitting a PR_ |
36 |
| -- _Is the commit message formatted correctly?_ |
37 |
| -- _Have you noted the new functionality/bugfix in the release notes of the next release?_ |
| 49 | +- [ ] |
| 50 | +- [ ] |
| 51 | + |
| 52 | +### CHECKLIST |
| 53 | + |
| 54 | +<!-- |
| 55 | +Here's a handy checklist to go through before submitting a PR, note that you can check a checkbox in Markdown by changing `- [ ]` to `- [x]` or you can create the PR and check the box manually. |
| 56 | +--> |
| 57 | + |
| 58 | +- [ ] _Is the commit message formatted correctly?_ |
| 59 | +- [ ] _Have you noted the new functionality/bugfix in the release notes of the next release?_ |
38 | 60 |
|
39 |
| -_If you've changed any code_ |
40 |
| -- _Included a sample plot to visually illustrate your changes?_ |
41 |
| -- _Do all of your functions and methods have docstrings?_ |
42 |
| -- _Have you added/updated unit tests where appropriate?_ |
43 |
| -- _Have you updated the baseline images if necessary?_ |
44 |
| -- _Have you run the unit tests using `pytest`?_ |
45 |
| -- _Is your code style correct (are you using PEP8, pyflakes)?_ |
46 |
| -- _Have you documented your new feature/functionality in the docs?_ |
47 |
| - |
48 |
| -_If you've added to the docs_ |
49 |
| -- _Have you built the docs using `make html`?_ |
| 61 | +<!-- If you've changed any code --> |
50 | 62 |
|
| 63 | +- [ ] _Included a sample plot to visually illustrate your changes?_ |
| 64 | +- [ ] _Do all of your functions and methods have docstrings?_ |
| 65 | +- [ ] _Have you added/updated unit tests where appropriate?_ |
| 66 | +- [ ] _Have you updated the baseline images if necessary?_ |
| 67 | +- [ ] _Have you run the unit tests using `pytest`?_ |
| 68 | +- [ ] _Is your code style correct (are you using PEP8, pyflakes)?_ |
| 69 | +- [ ] _Have you documented your new feature/functionality in the docs?_ |
51 | 70 |
|
| 71 | +<!-- If you've added to the docs --> |
52 | 72 |
|
| 73 | +- [ ] _Have you built the docs using `make html`?_ |
0 commit comments