Skip to content

Commit

Permalink
Merge pull request #10 from NillionNetwork/add-contributing-guid
Browse files Browse the repository at this point in the history
Add contributing guide and PR template
  • Loading branch information
oceans404 authored Apr 12, 2024
2 parents 73364a4 + 15f7546 commit a05f719
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
8 changes: 4 additions & 4 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
## 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

_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:
7 changes: 2 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -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

0 comments on commit a05f719

Please sign in to comment.