Docs: added a Pull Request Guidelines in CONTRIBUTING.md #1520
Conversation
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/pikapkg/snowpack/gnlk1289w |
CONTRIBUTING.md
Outdated
|
|
||
| - If fixing bug: | ||
|
|
||
| - If you are resolving a special issue, add `(fix #xxxx)` (#xxxx is the issue id) in your PR title for a better release. |
There was a problem hiding this comment.
If you can frame these as more "recommended" than "required", that would be great. Something like this format:
Checkout a topic branch from a base branch, e.g.
master, and merge back against that branch.Some tips for creating your first pull request:
- Provide background for why a PR was created.
- Link to any relevant issues, discussions, or past PRs
- ...
There was a problem hiding this comment.
I have followed your advice. Checked it please if you are free.
CONTRIBUTING.md
Outdated
|
|
||
| - If adding a new feature: | ||
|
|
||
| - Provide a convincing reason to add this feature. |
There was a problem hiding this comment.
If adding a feature, it probably should have been brought up in a "discussion" instead before the PR was created. If you're having to convince anyone that the feature is a good idea at the PR stage, it's probably too late (I have closing PRs that could have been fleshed out more as discussions)
|
LGTM |
Changes
Added a Pull Request Guidelines in CONTRIBUTING.md
Testing
All tests have been passed.
Docs
It's more convenient and efficient for contributors to create a pull request.