Skip to content

Commit 71fedf1

Browse files
authored
Add fork-pull docs (#137)
Fork-pull workflows enabled! Tested with #136 using an account that is not in the NI orgs. Updated CONTRIBUTING docs to describe the workflow and recommendations. Fixes #107
1 parent 17b4a43 commit 71fedf1

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

CONTRIBUTING.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,15 @@ The goal of the smoke tests is basic validation that the eslint configurations c
3939

4040
### Creating a pull request
4141

42-
Currently the repository only supports contributions by creating a branch and pull request (we hope to support a fork-pull workflow soon). Not all users can create a branch in this repo; contact @rajsite to be granted the necessary privileges.
42+
1. Create a fork of the repository.
43+
2. (optional, but recommended) On the Actions tab of your repository enable actions for the repo. This allows the tests to run in the branches of your fork.
44+
3. Create and edit a branch in your fork.
45+
4. Open a pull request to Nimble for the branch.
46+
- (optional, but recommended) While creating the pull request enable the "Allow edits and access to secrets by maintainers" option. This will allow maintainers to push small changes to the branch to resolve needed changes quicker.
47+
5. Create a beachball change file for your project by doing one of the following:
48+
1. Follow the [Beachball change file](#beachball-change-file) instructions below to create a change file and push to your branch.
49+
2. If you allowed maintainers to edit your branch, they may add a change file for you or request that you add one.
50+
6. Maintainers will review the PR, may request updates, and eventually merge and release the changes.
4351

4452
### Beachball change file
4553

0 commit comments

Comments
 (0)