New PR template #3255
+60
−39
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
| @@ -1,62 +1,83 @@ | ||
| <!-- | ||
| Hi, thanks for contributing to Wasp! | ||
|
|
||
| Comments like this one won't be shown in the final PR, but they contain | ||
| instructions to guide you. | ||
|
|
||
| Make sure to follow this PR template, so that we can speed up the review process. | ||
| It will also help you not forget important steps when making a change. | ||
|
|
||
| If you don't know how to fill any of the sections below, it's okay to leave them | ||
| blank, we will help you out during the review. | ||
| --> | ||
|
|
||
| ### Description | ||
|
|
||
| <!-- | ||
| Describe your PR! | ||
|
|
||
| Common questions we'd like you to answer: | ||
| - What's the motivation for this change? | ||
| - Which changes are included in this PR? | ||
| - If there are many different changes, consider splitting your PR into smaller | ||
| ones. It will go through faster! | ||
|
|
||
| If this PR closes an issue, write “Fixes #XXXX" so GitHub will link them together. | ||
|
|
||
| You can also answer some of these questions if they are relevant: | ||
| - Does this change affect users? How? | ||
| - Have you considered any other approaches? Why is this one the best? | ||
| - Are there any drawbacks or edge cases? | ||
| - What are the possibilities for future work? | ||
| --> | ||
|
|
||
| ### Select what type of change this PR introduces: | ||
|
|
||
| <!-- Put an x in between the brackets to select options, like so: [x] --> | ||
cprecioso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - [ ] **Just code/docs improvement** (no functional change). | ||
| - [ ] **Bug fix** (non-breaking change which fixes an issue). | ||
| - [ ] **New feature** (non-breaking change which adds functionality). | ||
| - [ ] **Breaking change** (fix or feature that would cause existing functionality to not work as expected). | ||
|
|
||
| ### Checklist | ||
|
|
||
| <!-- Put an x in between the brackets to select options, like so: [x] --> | ||
| <!-- You can add notes or explanations wherever needed --> | ||
|
|
||
| - 🧪 Testing: | ||
cprecioso marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| - [ ] I tested this change in a Wasp app **locally**. | ||
| - [ ] I added **unit tests** for my change at `waspc/tests`. | ||
| - [ ] <!-- If you added or updated a feature: --> I added **e2e tests** for my change at `waspc/examples/todoApp/e2e-tests`. | ||
| - [ ] <!-- If you added or updated a feature: --> I updated the **starters** at `waspc/data/Cli/templates`, if needed. | ||
| - [ ] <!-- If you fixed a bug: --> I added a **regression test** for the bug I fixed. | ||
|
|
||
| - 📜 Documentation: | ||
|
|
||
| - [ ] <!-- If you added a feature: --> I **added documentation** to the `web/docs/`, in a place that makes sense. | ||
| - [ ] <!-- If you updated a feature: --> I **searched** for all relevant places in the `web/docs/` and **updated** them, if needed. | ||
|
|
||
| - 🆕 Changelog: | ||
|
|
||
| <!-- If you did a bug fix, new feature, or breaking change: --> | ||
|
|
||
| - [ ] I updated `waspc/ChangeLog.md` with a **user-friendly** description of the change. | ||
| - [ ] I **bumped the `version`** in `waspc/waspc.cabal` to reflect changes I introduced. | ||
| - [ ] <!-- If you did a breaking change: --> I added a step to the current **migration guide** at `web/docs/migration-guides/`. | ||
|
|
||
| <!-- | ||
| While we're in beta, the version should be bumped according to the type of change: | ||
| - Bug fix: patch version (0.0.X). | ||
| - New feature: patch version (0.0.X). | ||
| - Breaking change: minor version (0.X.0). | ||
| If the version has already been bumped since the last release, you can skip this. | ||
|
There was a problem hiding this comment. I'm not sure if this is effective without being overbearing. Worst case scenario, we can just tell them to undo a change, or we can do it ourselves. |
||
| --> | ||
|
|
||
| <!-- | ||
| Thanks for contributing! :) | ||
|
|
||
| We'll check this PR as soon as we can. Meanwhile, keep an eye on this PR and | ||
| fix any errors that might come up in the checks. It should be all green before | ||
| we can merge it. | ||
| --> | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
So are they supposed to replace this comment with description, or write under it, or not to anything here and that is it? This would be confusing to me I think, where am I suppoed to write this exactly, or am I at all.
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 can do either, the comment doesn't affect anything. It can be safely removed or safely kept. That's why there's no specific guidance.
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.
Ok so I get your explanation, but still, my feeling was as I described above: I didn't know waht is expected, and that is fatiguing. Would be great if we can somehow remove that feeling of "what do I need to do here", even if all the choices are correct ones. Not sure if we can easily do it though, in that case I guess we stick with what we have, but I am challenging it.