-
Notifications
You must be signed in to change notification settings - Fork 250
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
📝 Break out PR checklist into its own doc.
- Loading branch information
1 parent
be0d7ce
commit df253f1
Showing
3 changed files
with
25 additions
and
13 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# 🌱 Ceedling Pull-Request Checklist | ||
|
||
Hello lovely developers! We hear you're interested in submitting some work to our project. Thanks! We really appreciate it! | ||
|
||
Below is a quick checklist of the things that need to be done before a full PR is merged to our project. Don't worry. You're not responsible for ALL of it. We'll accept your contribution however you are able to make it, with our thanks. But if you have some extra time and would like to maximize your contribution, here's a handy reference! | ||
|
||
### Documentation | ||
|
||
- [ ] Has `CeedlingPacket.md` been updated? (if it provides a new or changed feature) | ||
- [ ] Has `ReleaseNotes.md` been updated? (if it provides a new or changed feature) | ||
- [ ] Has `Changelog.md` been updated? (if it fixes something or provides something new) | ||
- [ ] Has `BreakingChanges.md` been updated? (if it changes compatibility with something that has existed before) | ||
|
||
### Software | ||
|
||
- [ ] Does it follow our coding standards? | ||
- [ ] Are all existing tests passing? | ||
- [ ] Are there new tests added and passing? | ||
- [ ] Have new config options been added as defaults to the `project.yml` files? | ||
- [ ] Does the feature follow our "Logical Defaults" philosophy where possible? | ||
- [ ] Has it passed a peer review? | ||
- [ ] Does it pass CI (continuous integration) tests? |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters