diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 9db8868..826e9dc 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,11 +1,11 @@ ## Description -_Concise description of proposed changes, We recommend using screenshots and videos for better description_ +Please add a concise description of proposed changes, We recommend using screenshots and videos for better description ## Additional Information -- [ ] I have read the [contributing docs](/scaffold-eth/scaffold-eth-2/blob/main/CONTRIBUTING.md) (if this is your first contribution) -- [ ] This is not a duplicate of any [existing pull request](https://github.com/scaffold-eth/scaffold-eth-2/pulls) +- [ ] I have read the [contributing docs](/NillionNetwork/scaffold-nillion/blob/main/CONTRIBUTING.md) (if this is your first contribution) +- [ ] This is not a duplicate of any [existing pull request](https://github.com/NillionNetwork/scaffold-nillion/pulls) ## Related Issues @@ -13,4 +13,4 @@ _Closes #{issue number}_ _Note: If your changes are small and straightforward, you may skip the creation of an issue beforehand and remove this section. However, for medium-to-large changes, it is recommended to have an open issue for discussion and approval prior to submitting a pull request._ -Your ENS/address: +Optional - Your ENS/address: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index bdd71c2..7b4c029 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -63,7 +63,8 @@ We follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr) 3. Create a new branch with a descriptive name 4. Commit your changes to the new branch 5. Push changes to your fork -6. Open a PR in our repository and tag one of the maintainers to review your PR +6. Open a PR in our repository by [creating a pull request from your fork](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) Use the "main" branch as the base branch, the branch in the repository that you want to merge your changes into. +7. Tag one of the maintainers to review your PR Here are some tips for a high-quality pull request: @@ -78,7 +79,3 @@ Once you submit your PR: - As you update your PR and apply changes, mark each conversation resolved. Once the PR is approved, we'll "squash-and-merge" to keep the git commit history clean. - -The PR will either be -- merged into main, for bug fixes -- merged into release, to be merged in with the next release