Comments (7)
What say you to these changes, @felddy and @mcdonnnj?
Edit: I now see that @mcdonnnj gave me a thumbs up reaction above.
from .github.
- Changes are limited to a single goal (no scope creep) - we are all guilty of this!!!
We probably need to remember that one in reviews as well honestly.
from .github.
Here's some changes I'd recommend; first is the raw, followed by the markup version:
# <!-- Use the title to describe PR changes in the imperative mood --> #
<!-- Follow the conventions of great Git commit messages from -->
<!-- https://chris.beams.io/posts/git-commit/ -->
## ๐ฃ Description ##
<!-- Describe the "what" of your changes in detail -->
<!-- To avoid scope creep, limit changes to a single goal -->
## ๐ญ Motivation and Context ##
<!-- Why is this change required? -->
<!-- What problem does this change solve? How did you solve it? -->
<!-- Link to any related issue(s) here to auto-close it on merge. -->
## ๐งช Testing ##
<!-- How did you test your changes? How could someone else test this PR? -->
<!-- Include details of your testing environment, and the tests you ran to -->
<!-- see how your change affects other areas of the code, etc. -->
## ๐ท Screenshots ##
<!-- Remove this section and header if not needed -->
## ๐ฅ Types of Changes ##
<!-- What types of changes does your code introduce? -->
<!-- Add any relevant types and remove any that don't apply -->
<!-- Consider making a PR against the template for new types -->
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (causes existing functionality to change)
- Documentation change or update
## โ
Checklist ##
<!-- Remove any of the following that do not apply. -->
<!-- Draft PRs should have several un-checked boxes still to go -->
<!-- If you're unsure about any of these, don't hesitate to ask. -->
<!-- We're here to help! -->
- [ ] PR has an informative and human-readable title
- [ ] Changes are limited to a single goal (no scope creep)
- [ ] Future todos are captured in issues and/or comments
- [ ] Added assignee and relevant labels
- [ ] I have read the [CONTRIBUTING](../blob/develop/CONTRIBUTING.md) document
- [ ] Code changes follow [cisagov code standards](https://github.com/cisagov/development-guide)
- [ ] Updated repo/project documentation to reflect changes in this PR
- [ ] Added tests to cover my changes
- [ ] All new and existing tests pass
๐ฃ Description
๐ญ Motivation and Context
๐งช Testing
๐ท Screenshots
๐ฅ Types of Changes
- Bug fix (non-breaking change which fixes an issue)
- New feature (non-breaking change which adds functionality)
- Breaking change (causes existing functionality to change)
- Documentation change or update
โ Checklist
- PR has an informative and human-readable title
- Changes are limited to a single goal (no scope creep)
- Future todos are captured in issues and/or comments
- Added assignee and relevant labels
- I have read the CONTRIBUTING document
- Code changes follow cisagov code standards
- Updated repo/project documentation to reflect changes in this PR
- Added tests to cover my changes
- All new and existing tests pass
from .github.
Totally agree! In the way that Github displays checklist summaries, it's expecting them to be required items like "acceptance criteria" or "things that must be complete to consider this work Done."
Here's the CFPB's PR template checklist, for a possibly helpful example: https://github.com/cfpb/consumerfinance.gov/blob/main/.github/PULL_REQUEST_TEMPLATE.md#checklist
from .github.
Here's the CFPB's PR template checklist, for a possibly helpful example: https://github.com/cfpb/consumerfinance.gov/blob/main/.github/PULL_REQUEST_TEMPLATE.md#checklist
I heartily endorse the addition of these thangs from the CFPB PR template:
- PR has an informative and human-readable title
- Changes are limited to a single goal (no scope creep) - we are all guilty of this!!!
- Future todos are captured in comments and/or tickets - ditto!!!
from .github.
โ๏ธ I'm on board with these changes! ๐
from .github.
- Changes are limited to a single goal (no scope creep) - we are all guilty of this!!!
We probably need to remember that one in reviews as well honestly.
Very good point. We'll have to work to keep each other honest.
from .github.
Related Issues (16)
- Consider adding an "On Hold" label HOT 5
- none HOT 1
- Update pull request template with pre- and post- approval checklists
- Reconcile PR template and issue template titles
- Create a "Code of Conduct" document and handle violation reports HOT 1
- Rename main branch to develop HOT 1
- Change the first heading in the pull request template to be useful
- Tag known Tor Node or VPN IP HOT 1
- Consolidate and simplify issue templates HOT 7
- Modify the PR template after implementation of automatic release generation foo
- Please Provide me step by step installation process HOT 1
- Troubles with Docker Image HOT 1
- Issue with Ubuntu 20.04 LTS. HOT 1
- suricata
- Standardize org-wide labels HOT 28
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from .github.