Skip to content

Commit

Permalink
Update contribution guide to include upstream tags fetch step
Browse files Browse the repository at this point in the history
  • Loading branch information
sbkok committed Jan 15, 2024
1 parent 680b0f8 commit fe761ba
Showing 1 changed file with 14 additions and 4 deletions.
18 changes: 14 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,10 +73,20 @@ npx mega-linter-runner --fix

## Deploy your changes

To deploy your changes, make sure to commit them in your local repository
first. Once committed, follow the [installation
guide](./docs/installation-guide.md) to deploy them into your management
account.
1. To deploy your changes, make sure to commit them in your local repository
first.
2. If you are working on your own fork, make sure to add the upstream
repository as a remote and fetch its tags. As these tags are used to
generate the version number. You do this by:

```bash
git remote add upstream https://github.com/awslabs/aws-deployment-framework
git fetch upstream --tags
```

3. Once you committed and optionally fetched the upstream repo tags, follow the
[installation guide](./docs/installation-guide.md) to deploy them into your
management account.

## Contributing via Pull Requests

Expand Down

0 comments on commit fe761ba

Please sign in to comment.