Skip to content
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.

Sign up for GitHub

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

Docs: added a Pull Request Guidelines in CONTRIBUTING.md #1520

Merged
merged 15 commits into from
Nov 6, 2020
Merged

Docs: added a Pull Request Guidelines in CONTRIBUTING.md #1520

Changes from 11 commits
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
77f1e62
fix: updated snapshot and added shein logo and website
iam-frankqiu Oct 30, 2020
0099feb
merge master branch code
iam-frankqiu Nov 1, 2020
2495d12
chore: deleted alias in installOptions
iam-frankqiu Nov 1, 2020
d1489d9
Merge branch 'master' of github.com:pikapkg/snowpack
iam-frankqiu Nov 1, 2020
f911c20
chore: deleted alias in installOptions
iam-frankqiu Nov 1, 2020
cf89b88
chore: drop the alias in installOptions in SnowpackConfig interface
iam-frankqiu Nov 2, 2020
3a2da5a
chore: merge branch
iam-frankqiu Nov 3, 2020
6e8df1c
Merge remote-tracking branch 'upstream/master'
iam-frankqiu Nov 3, 2020
03dae8c
Merge remote-tracking branch 'upstream/master'
iam-frankqiu Nov 4, 2020
ca6b4d7
docs: added a Pull Request Guidelines
iam-frankqiu Nov 5, 2020
6fbcb68
[ci] yarn format
iam-frankqiu Nov 5, 2020
d389453
docs: submitted a revised pull request guidelines.
iam-frankqiu Nov 6, 2020
bd699a2
Merge remote-tracking branch 'upstream/master'
iam-frankqiu Nov 6, 2020
3ad97f4
[ci] yarn format
iam-frankqiu Nov 6, 2020
4471367
Update CONTRIBUTING.md
FredKSchott Nov 6, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,23 @@ Note the path must start with must start with a `.` to be considered local

The `--verbose` flag enables additional logs which will help to identify the source of a problem. The `--reload` will clear the local cache which might have been created by a different `snowpack` version. Learn more about [Snowpack's CLI flags](https://www.snowpack.dev/#cli-flags).

## Pull Request Guidelines

- Checkout a topic branch from a base branch, e.g. `master`, and merge back against that branch.

- If adding a new feature:

- Provide a convincing reason to add this feature.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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)

- Add accompanying tests if applicable.

- 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.
Copy link
Owner

@FredKSchott FredKSchott Nov 5, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
  • ...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have followed your advice. Checked it please if you are free.

- Provide a detailed description of the bug in the PR. Live demo preferred.
- Add appropriate tests if applicable.

- Ensure all tests have been passed.

## Discussion

[Join the Pika Discord](https://discord.gg/rS8SnRk)