Skip to content

update CONTRIBUTING.md with build instructions #30

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
that1guy15 merged 1 commit into from
May 20, 2022
Merged

update CONTRIBUTING.md with build instructions #30

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,17 @@ Black is used to format code pre-commit
```
black aos/
black tests/
```
```

## Building Releases
This function is currently handled by the project admin team. GitHub
releases is currently used for release management. Git tags are used to
manage release version numbers.
### steps
1. `git tag v0.x.y-beta`
2. `git push --tags`
3. From Github validate the new tag is present with the correct commit.
4. From Github create a new release based on the new tag.
5. Github actions will then pick up the new release and trigger a release
build and publish to pypi using the tagged version number