Skip to content

Commit 4f41657

Browse files
committed
Updated CONTRIBUTING.md with fork/PR submission info
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
1 parent cfd0487 commit 4f41657

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,14 @@ We prefer to not squash commits when merging a PR because, especially for larger
7171
- During review, the commits can be reviewed individually, making each review chunk smaller
7272
- 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.
7373

74+
## Opening a PR
75+
76+
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.
77+
78+
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).
79+
80+
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.
81+
7482
## Review and CI Testing
7583

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

0 commit comments

Comments
 (0)