Skip to content

Update CONTRIBUTING.md to use a Fork Based workflow #5

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.

Sign up for GitHub

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

Merged
danieljurek merged 2 commits into from
Jul 7, 2022
Merged

Update CONTRIBUTING.md to use a Fork Based workflow #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d3d8fc3
Update CONTRIBUTING.md to use a Fork Based workflow
ellismg Jul 7, 2022
f8efc25
Exclude `NOTICE.txt` from cspell
ellismg Jul 7, 2022
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
4 changes: 3 additions & 1 deletion .vscode/cspell.global.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ version: 0.2
language: en
ignorePaths:
- ./go.mod
- go.sum
- ./go.sum
- ./NOTICE.txt
- ./templates/common/NOTICE.txt
words:
- opentelemetry
- bson
Expand Down
11 changes: 7 additions & 4 deletions cli/azd/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ Also, you'll want to install Docker (as we use that for some of our tests)

## Submitting A Change

As part of our pre-check-in validation we run tests that require creating Azure resources. Right now this requires that PRs don't come from Forks.
We used a fork based workflow for `azd`.

1. Create a branch named `<your-github-user>/<some-description>` (e.g. `ellismg/fix-123` for a bug fix or `ellismg/add-deploy-command`).
2. Push the branch to `azure/azure-dev` on GitHub.
3. Open a pull request in GitHub.
1. Fork `azure/azure-dev` on GitHub.
2. Create a branch named `<some-description>` (e.g. `fix-123` for a bug fix or `add-deploy-command`).
3. Push the branch to your fork on GitHub.
4. Open a pull request in GitHub.

As part of CI validation - we run a series of live tests which provison and deprovision Azure resources. For external contributors, these tests will not run automatically, but someone on the team will be able to run them for your PR on your behalf.

## Debugging

Expand Down