Skip to content

Commit

Permalink
ignore emphasis marker and list item indent markdown, too annoying, i…
Browse files Browse the repository at this point in the history
…gnore requirements txts, md formatting
  • Loading branch information
rbavery committed Oct 31, 2024
1 parent 415671b commit edaa966
Show file tree
Hide file tree
Showing 11 changed files with 940 additions and 746 deletions.
7 changes: 3 additions & 4 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,9 @@ Steps to reproduce the behavior:

### Environment

* OS: (e.g. Linux / Windows / macOS)
* Python version
* stac-model version

- OS: (e.g. Linux / Windows / macOS)
- Python version
- stac-model version

## :chart_with_upwards_trend: Expected behavior

Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ assignees:
## :sound: Motivation

<!--
Please describe the motivation for this proposal, such as the problem it solves,
Please describe the motivation for this proposal, such as the problem it solves,
the intended users for the feature and what does success look like and how we can measure that.
-->

Expand Down
3 changes: 2 additions & 1 deletion .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,8 @@ assignees:

<!-- Mark with an `x` all the checkboxes that apply (like `[x]`) -->

- [ ] I've searched the project's [`issues`](..), looking for the following terms:
- [ ] I've searched the project's [`issues`](..), looking for the following
terms:
- [...]

## :question: Question
Expand Down
9 changes: 6 additions & 3 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,11 @@

- [ ] :books: Examples, docs, tutorials or dependencies update;
- [ ] :wrench: Bug fix (non-breaking change which fixes an issue);
- [ ] :clinking_glasses: Improvement (non-breaking change which improves an existing feature);
- [ ] :clinking_glasses: Improvement (non-breaking change which improves an
existing feature);
- [ ] :rocket: New feature (non-breaking change which adds functionality);
- [ ] :boom: Breaking change (fix or feature that would cause existing functionality to change);
- [ ] :boom: Breaking change (fix or feature that would cause existing
functionality to change);
- [ ] :closed_lock_with_key: Security fix.

## Checklist
Expand All @@ -24,4 +26,5 @@
- [ ] I've read the [`CONTRIBUTING.md`](../CONTRIBUTING.md) guide;
- [ ] I've updated the code style using `make check`;
- [ ] 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.
- [ ] I've written the docstring in `Google` format for all the methods and
classes that I used.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
requirements*

### ArchLinuxPackages ###
*.tar
*.tar.*
Expand Down
273 changes: 159 additions & 114 deletions CHANGELOG.md

Large diffs are not rendered by default.

80 changes: 44 additions & 36 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
make setup
```

> This installs uv as a [standalone application][uv-install]. <br>
> For more details, see also the [UV Documentation][uv-docs]. <br>
> This installs uv as a [standalone application][uv-install]. <br> For more
> details, see also the [UV Documentation][uv-docs]. <br>
2. Initialize project dependencies with uv and install `pre-commit` hooks:

Expand All @@ -18,7 +18,10 @@ make install-dev
make pre-commit-install
```

**Note** All Makefile commands will use uv to install dependencies into the currently active python environment as determined by `which python`. If you prefer to use an mlm project-scoped, environment that is managed by uv, use uv commands directly and don't use the Makefile.
**Note** All Makefile commands will use uv to install dependencies into the
currently active python environment as determined by `which python`. If you
prefer to use an mlm project-scoped, environment that is managed by uv, use uv
commands directly and don't use the Makefile.

## PR submission

Expand All @@ -42,7 +45,8 @@ make lint-all
make test
```

6. Upload your changes to your fork, then make a PR from there to the main repo:
6. Upload your changes to your fork, then make a PR from there to the main
repo:

```bash
git checkout -b your-branch
Expand All @@ -56,66 +60,70 @@ git push -u origin your-branch

<!-- lint disable no-undefined-references -->

> [!WARNING]
> There are multiple types of releases for this repository: <br>
> [!WARNING] There are multiple types of releases for this repository: <br>
>
> 1. Release for MLM specification (usually, this should include one for `stac-model` as well to support it)
> 1. Release for MLM specification (usually, this should include one for
> `stac-model` as well to support it)
> 2. Release for `stac-model` only
<!-- lint enable no-undefined-references -->

### Building a new version of MLM specification

- Checkout to the `main` branch by making sure the CI passed all previous tests.
- Bump the version with `bump-my-version bump --verbose <version-level>`.
- Consider using `--dry-run` beforehand to inspect the changes.
- The `<version-level>` should be one of `major`, `minor`, or `patch`. <br>
Alternatively, the version can be set explicitly with `--new-version <version> patch`. <br>
For more details, refer to the [Semantic Versions][semver] standard;
- Make a commit to `GitHub` and push the corresponding auto-generated `v{MAJOR}.{MINOR}.{PATCH}` tag.
- Validate that the CI validated everything once again.
- Create a `GitHub release` with the created tag.
- Checkout to the `main` branch by making sure the CI passed all previous tests.
- Bump the version with `bump-my-version bump --verbose <version-level>`.
- Consider using `--dry-run` beforehand to inspect the changes.
- The `<version-level>` should be one of `major`, `minor`, or `patch`. <br>
Alternatively, the version can be set explicitly with
`--new-version <version> patch`. <br> For more details, refer to the
[Semantic Versions][semver] standard;
- Make a commit to `GitHub` and push the corresponding auto-generated
`v{MAJOR}.{MINOR}.{PATCH}` tag.
- Validate that the CI validated everything once again.
- Create a `GitHub release` with the created tag.

<!-- lint disable no-undefined-references -->

> [!WARNING]
>
> - Ensure the "Set as the latest release" option is selected :heavy_check_mark:.
> - Ensure the diff ranges from the previous MLM version, and not an intermediate `stac-model` release.
> - Ensure the "Set as the latest release" option is selected
> :heavy_check_mark:.
> - Ensure the diff ranges from the previous MLM version, and not an
> intermediate `stac-model` release.
<!-- lint enable no-undefined-references -->

### Building a new version of `stac-model`

- Apply any relevant changes and `CHANGELOG.md` entries in a PR that modifies `stac-model`.
- Bump the version with `uv run bump-my-version bump <version>`.
- You can pass the new version explicitly, or a rule such as `major`, `minor`, or `patch`. <br>
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.
- Create a `GitHub release`
- Apply any relevant changes and `CHANGELOG.md` entries in a PR that modifies
`stac-model`.
- Bump the version with `uv run bump-my-version bump <version>`.
- You can pass the new version explicitly, or a rule such as `major`, `minor`,
or `patch`. <br> 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.
- Create a `GitHub release`

<!-- lint disable no-undefined-references -->

> [!WARNING]
>
> - Ensure the "Set as the latest release" option is deselected :x:.
> - Ensure the diff ranges from the previous release of `stac-model`, not an intermediate MLM release.
> - Ensure the "Set as the latest release" option is deselected :x:.
> - Ensure the diff ranges from the previous release of `stac-model`, not an
> intermediate MLM release.
<!-- lint enable no-undefined-references -->

## Other help

You can contribute by spreading a word about this library.
It would also be a huge contribution to write
a short article on how you are using this project.
You can also share how the ML Model extension does or does
not serve your needs with us in the GitHub Discussions or raise
Issues for bugs.
You can contribute by spreading a word about this library. It would also be a
huge contribution to write a short article on how you are using this project.
You can also share how the ML Model extension does or does not serve your needs
with us in the GitHub Discussions or raise Issues for bugs.

[uv-install]: https://docs.astral.sh/uv/getting-started/installation/

[uv-docs]: https://docs.astral.sh/uv/

[semver]: https://semver.org/
Loading

0 comments on commit edaa966

Please sign in to comment.