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

Update CONTRIBUTING.md #18

Merged
merged 2 commits into from
May 8, 2024
Merged

Update CONTRIBUTING.md #18

merged 2 commits into from
May 8, 2024

Conversation

fmigneault
Copy link
Collaborator

@fmigneault fmigneault commented May 7, 2024

Description

Apply the different workflows for the multi-release context of the repo.

Related Issue

Type of Change

  • 📚 Examples, docs, tutorials or dependencies update;
  • 🔧 Bug fix (non-breaking change which fixes an issue);
  • 🥂 Improvement (non-breaking change which improves an existing feature);
  • 🚀 New feature (non-breaking change which adds functionality);
  • 💥 Breaking change (fix or feature that would cause existing functionality to change);
  • 🔐 Security fix.

Checklist

  • I've read the CONTRIBUTING.md guide;
  • I've updated the code style using make codestyle;
  • I've written tests for all new methods and classes that I created;
  • I've written the docstring in Google format for all the methods and classes that I used.

Apply the different workflows for the multi-release context of the repo.
@fmigneault fmigneault requested a review from rbavery May 7, 2024 19:10
@fmigneault fmigneault self-assigned this May 7, 2024
@fmigneault fmigneault added the documentation Improvements or additions to documentation label May 7, 2024
For more details, refer to the [Semantic Versions][semver] standard;
- Once CI validation succeeded, merge the corresponding PR branch.
- Checkout to `main` branch that contais the freshly created merge commit.
- Push the tag `stac-model-v{MAJOR}.{MINOR}.{PATCH}`. The CI should auto-publish it to PyPI.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pushing the tag manually rather than specifying it during the release drafting in the next step triggers the action, thanks for the clear instructions!

@fmigneault fmigneault merged commit 3848c83 into main May 8, 2024
8 checks passed
@fmigneault fmigneault deleted the update-contributing branch May 8, 2024 14:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants