Skip to content

Commit 618643a

Browse files
authored
Improve contribution guidelines + PR template (#65)
1 parent 0d6d989 commit 618643a

File tree

2 files changed

+64
-14
lines changed

2 files changed

+64
-14
lines changed

.github/CONTRIBUTING.md

Lines changed: 36 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
# Contributing
22

3-
The following is a set of guidelines for contributing to the project. Please take a moment to read through them before submitting your first PR.
3+
The following is a set of guidelines for contributing to the project. Please
4+
take a moment to read through them before submitting your first PR.
45

56
## Code of Conduct
67

7-
This project and everyone participating in it are governed by the [Code of Conduct](/.github/CODE_OF_CONDUCT.md).
8-
By participating, you are expected to uphold this code. Please report unacceptable
9-
behavior to [[email protected]](mailto:[email protected]).
8+
This project and everyone participating in it are governed by the
9+
[Code of Conduct](/.github/CODE_OF_CONDUCT.md). By participating, you are
10+
expected to uphold this code. Please report unacceptable behavior to
11+
1012

1113
## Welcomed Contributions
1214

@@ -24,7 +26,9 @@ behavior to [[email protected]](mailto:[email protected]).
2426

2527
## Proposing Features
2628

27-
When in doubt about whether we will be interested in including a new feature in this project, please open an issue to propose the feature so we can confirm the feature should be in scope for the project before it is implemented.
29+
When in doubt about whether we will be interested in including a new feature in
30+
this project, please open an issue to propose the feature so we can confirm the
31+
feature should be in scope for the project before it is implemented.
2832

2933
## How To Contribute
3034

@@ -34,4 +38,30 @@ When in doubt about whether we will be interested in including a new feature in
3438
4. Verify the changes locally (e.g. via the sample app)
3539
5. Commit your changes and push
3640
6. Ensure all checks (e.g. tests) are passing in GitHub
37-
7. Create a new pull request with a detailed description of what is changing and why
41+
7. Create a new pull request with a detailed description of what is changing and
42+
why
43+
44+
## Releasing a new version
45+
46+
Open a pull request with the following changes:
47+
48+
1. Bump the
49+
[package version](https://github.com/Shopify/checkout-sheet-kit-react-native/blob/main/modules/%40shopify/checkout-sheet-kit/package.json#L4)
50+
of the `@shopify/checkout-sheet-kit` module.
51+
2. Add an entry to the top of the [CHANGELOG](../CHANGELOG.md)
52+
53+
Once you have merged a pull request with these changes, you will be ready to
54+
publish a new version.
55+
56+
To do so, navigate to
57+
https://github.com/Shopify/checkout-sheet-kit-react-native/releases and click
58+
"Draft a new release" then complete the following steps:
59+
60+
1. Create a tag for the new version
61+
2. Use the same tag as the name for the version
62+
3. Document a full list of changes since the previous release, tagging merged
63+
pull requests where applicable, in the description box.
64+
4. Check "Set as the latest release".
65+
5. When ready, click "Publish release". This will kickstart the
66+
[CI process](https://github.com/Shopify/checkout-sheet-kit-react-native/actions/workflows/publish.yml)
67+
to publish a new version of the NPM package.

.github/pull_request_template.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,31 @@
1-
### What are you trying to accomplish?
1+
### What changes are you making?
22

3-
<!-- Optional: add instructions to describe how to test -->
3+
<!-- Please describe why you are making these changes -->
44

5-
### Before you deploy
5+
### How to test
66

7-
- [ ] I have added tests to support my implementation
8-
- [ ] I have read and agree with the contributing documentation [readme](/.github/CONTRIBUTING.md)
9-
- [ ] I have read and agree with the code of conduct documentation [readme](/.github/CODE_OF_CONDUCT.md)
10-
- [ ] I have updated any documentation related to these changes.
11-
- [ ] I have updated the [README](/README.md) (if applicable).
7+
<!-- Please outline the steps to test your changes -->
8+
9+
---
10+
11+
### PR Checklist
12+
13+
> [!IMPORTANT]
14+
>
15+
> - [ ] I've added tests to support my implementation
16+
> - [ ] I have read and agree with the [Contribution Guidelines](https://github.com/shopify/checkout-sheet-kit-react-native/blob/main/.github/CONTRIBUTING.md).
17+
> - [ ] I have read and agree with the [Code of Conduct](https://github.com/shopify/checkout-sheet-kit-react-native/blob/main/.github/CODE_OF_CONDUCT.md).
18+
> - [ ] I've updated the [README](https://github.com/shopify/checkout-sheet-kit-react-native).
19+
> - [ ] I've updated any documentation related to these changes.
20+
21+
---
22+
23+
<details>
24+
<summary>Checklist for releasing a new version</summary>
25+
26+
- [ ] I have bumped the version number in the [`package.json` file](https://github.com/Shopify/checkout-sheet-kit-react-native/blob/main/modules/%40shopify/checkout-sheet-kit/package.json#L4).
27+
- [ ] I have added a [Changelog](./CHANGELOG.md) entry.
28+
</details>
29+
30+
> [!TIP]
31+
> See the [Contributing documentation](./CONTRIBUTING.md#releasing-a-new-version) for instructions on how to publish a new version of the library.

0 commit comments

Comments
 (0)