Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fork-pull docs #137

Merged
merged 1 commit into from
Mar 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,15 @@ The goal of the smoke tests is basic validation that the eslint configurations c

### Creating a pull request

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.
1. Create a fork of the repository.
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.
3. Create and edit a branch in your fork.
4. Open a pull request to Nimble for the branch.
- (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.
5. Create a beachball change file for your project by doing one of the following:
1. Follow the [Beachball change file](#beachball-change-file) instructions below to create a change file and push to your branch.
2. If you allowed maintainers to edit your branch, they may add a change file for you or request that you add one.
6. Maintainers will review the PR, may request updates, and eventually merge and release the changes.

### Beachball change file

Expand Down