-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add pull request template #2843
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
c71f878 to
3d8a04e
Compare
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| ### Bug or feature | ||
|
|
||
| - [ ] Bug | ||
| - [ ] Feature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why is this important? Shouldn't this be obvious from the pull request description?
IMO, backwards compatibility is the most important concern to address when sending a pull request.
- [ ] backwards compatible
- [ ] breaking change(s)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, bug or feature is pretty useless in terms of PR. Will update with your description instead. 👍
ca70b4a to
ae58eb5
Compare
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| ### Bug or feature | ||
|
|
||
| - [ ] Bug | ||
| - [ ] Feature |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree, bug or feature is pretty useless in terms of PR. Will update with your description instead. 👍
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| - [ ] MAJOR -- Incompatible API changes (ie. breaking change(s)) | ||
| - [ ] MINOR -- Add functionality in a backwards-compatible manner | ||
| - [ ] PATCH -- Backwards-compatible bug fixes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bajtos Actually, I took your idea and went a step further. Why don't we get community to suggest the type of change they are submitting? We follow semver anyways, so it's something they can do for us. Thoughts?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
|
@bajtos PTAL again |
bajtos
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| See http://semver.org/ for more info. | ||
| --> | ||
|
|
||
| - [ ] MAJOR -- Incompatible API changes (ie. breaking change(s)) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Backwards-incompatible changes
- Just "incompatible" does not say what we are not compatible with
- It's not only about API, a change in behaviour requires SEMVER-MAJOR too.
I am also proposing to prefix all three items with SEMVER-, e.g. SEMVER-MAJOR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
FYI, those words were copied off of the semver doc at semver.org. They're probably intentionally generic to cover all areas. Updating with your wording since it's more specific.
.github/PULL_REQUEST_TEMPLATE.md
Outdated
|
|
||
| - [ ] MAJOR -- Incompatible API changes (ie. breaking change(s)) | ||
| - [ ] MINOR -- Add functionality in a backwards-compatible manner | ||
| - [ ] PATCH -- Backwards-compatible bug fixes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| - [ ] Commit message conforms with the [Git commit message | ||
| guidelines](http://loopback.io/doc/en/contrib/git-commit-messages.html) | ||
| - [ ] Code includes passing unit tests (`npm test`) | ||
| - [ ] Code passes linting (`npm run lint` or `npm test` which also runs the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I would rephrase these two items:
- [ ] New tests are added to cover all changes
- [ ] Code passes `npm test`
6e07a3b to
652c1cb
Compare
|
@bajtos PTAL again |
| --> | ||
|
|
||
| - [ ] SEMVER-MAJOR -- Backward-incompatible changes | ||
| - [ ] SEMVER-MINOR -- Add functionality in a backwards-compatible manner |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can we make it consistent? Either backward or backwards?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right, its a typo.
652c1cb to
3d913a9
Compare
|
@0candy PTAL again |
* Need index on principalId for performance. (#2883) (#2884) (Simon Ho) * Remove redundant items in PR template (#2877) (#2878) (Simon Ho) * Refactor PR template based on feedback (#2865) (#2874) (Simon Ho) * Add pull request template (#2843) (#2862) (Simon Ho) * Fix description of updateAll response (Miroslav Bajtoš)
* Fix use-strict issue with connectors after merge (Loay) * Fix connector naming in strict mode (ebarault) * Add "returnOnlyRoleNames" option to Role.getRoles (Eric) * Update translation files (Candy) * Fix broken document for `upsertWithWhere` (Amir Jafarian) * Fix js doc for deleteAll event (Candy) * add allowArray to relations' create remoteMethod (David Cheung) * Remove workaround for default value (Loay) * Fix remote method example (Amir Jafarian) * Remove `example/context` (Amir Jafarian) * Turn on "no-unused-expressions" rule for eslint (Miroslav Bajtoš) * Update eslint to loopback config v5 (Loay) * Fix total calculation in example (Candy) * make test individually runable (David Cheung) * Add options to bulkUpdate (Kogulan Baskaran) * Fix context within listByPrincipalType role method (codyolsen) * Add Node v7 to Travis CI platforms (Miroslav Bajtoš) * Drop support for Node v0.10 and v0.12 (Miroslav Bajtoš) * Add templateFn option to User#verify() (Adrien Kiren) * Require verification after email change (Loay) * Update doc links (Candy) * adding check of string for case insensitive emails (Dhaval Trivedi) * Update test confirmation text in PR template (#2897) (Simon Ho) * allow batch create for persisted models (David Cheung) * Fix PR template to not link all PRs to #49 (#2887) (Miroslav Bajtoš) * Need index on principalId for performance. (#2883) (Simon Ho) * Remove redundant items in PR template (#2877) (Simon Ho) * Refactor PR template based on feedback (#2865) (Simon Ho) * Add pull request template (#2843) (Simon Ho) * Update README.md (Rand McKinney) * Reword ticking checkbox note in issue template (#2854) (Simon Ho) * Add how to tick checkbox in issue template (#2851) (Simon Ho) * Fix description of updateAll response (Miroslav Bajtoš) * Allow tokens with eternal TTL (value -1) (Miroslav Bajtoš) * Use GitHub issue templates (#2810) (Simon Ho) * Update ja and nl translation files (Candy) * Remove 3.0 DEVELOPING & RELEASE-NOTES (Miroslav Bajtoš) * Fix support for remote hooks returning a Promise (Tim van der Staaij) * Validate non-email property partial update (Loay) * Update release notes (Amir Jafarian) * Update translation files - round#2 (Candy) * Add license text (Candy) * Temporarily disable Karma tests on Windows CI (Miroslav Bajtoš)
* Fix use-strict issue with connectors after merge (Loay) * Fix connector naming in strict mode (ebarault) * Add "returnOnlyRoleNames" option to Role.getRoles (Eric) * Update translation files (Candy) * Fix broken document for `upsertWithWhere` (Amir Jafarian) * Fix js doc for deleteAll event (Candy) * add allowArray to relations' create remoteMethod (David Cheung) * Remove workaround for default value (Loay) * Fix remote method example (Amir Jafarian) * Remove `example/context` (Amir Jafarian) * Turn on "no-unused-expressions" rule for eslint (Miroslav Bajtoš) * Update eslint to loopback config v5 (Loay) * Fix total calculation in example (Candy) * make test individually runable (David Cheung) * Add options to bulkUpdate (Kogulan Baskaran) * Fix context within listByPrincipalType role method (codyolsen) * Add Node v7 to Travis CI platforms (Miroslav Bajtoš) * Drop support for Node v0.10 and v0.12 (Miroslav Bajtoš) * Add templateFn option to User#verify() (Adrien Kiren) * Require verification after email change (Loay) * Update doc links (Candy) * adding check of string for case insensitive emails (Dhaval Trivedi) * Update test confirmation text in PR template (strongloop#2897) (Simon Ho) * allow batch create for persisted models (David Cheung) * Fix PR template to not link all PRs to strongloop#49 (strongloop#2887) (Miroslav Bajtoš) * Need index on principalId for performance. (strongloop#2883) (Simon Ho) * Remove redundant items in PR template (strongloop#2877) (Simon Ho) * Refactor PR template based on feedback (strongloop#2865) (Simon Ho) * Add pull request template (strongloop#2843) (Simon Ho) * Update README.md (Rand McKinney) * Reword ticking checkbox note in issue template (strongloop#2854) (Simon Ho) * Add how to tick checkbox in issue template (strongloop#2851) (Simon Ho) * Fix description of updateAll response (Miroslav Bajtoš) * Allow tokens with eternal TTL (value -1) (Miroslav Bajtoš) * Use GitHub issue templates (strongloop#2810) (Simon Ho) * Update ja and nl translation files (Candy) * Remove 3.0 DEVELOPING & RELEASE-NOTES (Miroslav Bajtoš) * Fix support for remote hooks returning a Promise (Tim van der Staaij) * Validate non-email property partial update (Loay) * Update release notes (Amir Jafarian) * Update translation files - round#2 (Candy) * Add license text (Candy) * Temporarily disable Karma tests on Windows CI (Miroslav Bajtoš)
We can update this over time as needed -- submitting my first stab at this to get the ball rolling.
@bajtos @strongloop/loopback-dev PTAL
Connect to #2837