Skip to content

Commit

Permalink
Updated CONTRIBUTING.md with fork/PR submission info
Browse files Browse the repository at this point in the history
To make it clear on how others can contribute to the project there's
now a dedicated section on how to raise a PR including a link to GitHub's
documentation on forking repos
  • Loading branch information
adammcarter committed Mar 29, 2024
1 parent cfd0487 commit 4f41657
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,14 @@ We prefer to not squash commits when merging a PR because, especially for larger
- During review, the commits can be reviewed individually, making each review chunk smaller
- In case this PR introduced a bug that is identified later, it is possible to check if it resulted from the refactoring or the actual change, thereby making it easier find the lines that introduce the issue.

## Opening a PR

To submit a PR you don't need permissions on this repo, instead you can fork the repo and create a PR through your forked version.

For more information and instructions, read the GitHub docs on [forking a repo](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo).

Once you've pushed your branch, you should see an option on this repository's page to create a PR from a branch in your fork.

## Review and CI Testing

After you opened your PR, a maintainer will review it and test your changes in CI (*Continuous Integration*) by adding a `@swift-ci Please test` comment on the pull request. Once your PR is approved and CI has passed, the maintainer will merge your pull request.
Expand Down

0 comments on commit 4f41657

Please sign in to comment.