Skip to content

Commit 59aaf5c

Browse files
bbengfortrebeccabilbro
authored andcommitted
Pull request template revisions (PR DistrictDataLabs#882)
This contribution updates our pull request template to provide more clear guidance to contributors about PR requirements
1 parent a39df0d commit 59aaf5c

File tree

1 file changed

+56
-35
lines changed

1 file changed

+56
-35
lines changed

.github/PULL_REQUEST_TEMPLATE.md

+56-35
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,73 @@
1-
### Welcome, Contributor!
2-
This template is meant to get your PR started off on the right foot.
1+
<!--
2+
# Welcome Contributor!
33
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.
66
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+
-->
920

10-
### III. Summarize your PR (HINT: See CHECKLIST below!)
1121
This PR fixes #issue_number _(If you are fixing a bug)_ which reported a bug that caused a problem to occur when users...
22+
1223
_(or if you are introducing a new feature)_ which requested a feature to allow the user to...
1324

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.
1830

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
2132

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+
-->
2440

2541
Still to do:
26-
- [ ]
27-
- [ ]
28-
- [ ]
42+
43+
- [ ]
44+
- [ ]
45+
- [ ]
2946

3047
Questions for the @DistrictDataLabs/team-oz-maintainers:
31-
- [ ]
32-
- [ ]
3348

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?_
3860

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 -->
5062

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?_
5170

71+
<!-- If you've added to the docs -->
5272

73+
- [ ] _Have you built the docs using `make html`?_

0 commit comments

Comments
 (0)