Skip to content

Commit 826cff2

Browse files
authored
chore: update pr template (#872)
1 parent f3a3517 commit 826cff2

File tree

4 files changed

+41
-30
lines changed

4 files changed

+41
-30
lines changed

.github/pull_request_template.md

Lines changed: 8 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,18 @@
1-
## Closes
1+
### Description
22

3-
- List any issues that this pull request closes
4-
- Delete this section if it is not applicable
3+
Description of the changes, including any "sidecar" changes that came along (e.g. small bugfixes you found along the way).
54

6-
## Related to
5+
### Related issues
76

8-
- List any issues that this pull request is related to
7+
- List any issues that this pull request closes or is related to
98
- Delete this section if it is not applicable
109

11-
## Description
12-
13-
Description of the changes, including any "sidecar" changes that came along (e.g. small bugfixes you found along the way).
14-
15-
## Checklist
10+
### Checklist
1611

1712
Delete any checklist items that do not apply (e.g. if your change is minor, it may not require documentation updates).
1813

1914
- [ ] Unit tests
2015
- [ ] Documentation, including doctests
21-
- [ ] Git history is linear
22-
- [ ] Commit messages are descriptive
23-
- [ ] (optional) Git commit messages follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
24-
- [ ] Code is formatted (`cargo fmt`)
25-
- [ ] `cargo test`
26-
- [ ] Changes are added to the CHANGELOG
27-
28-
<!-- markdownlint-disable-file MD041 -->
16+
- [ ] Pull request title follows [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
17+
- [ ] Pre-commit hooks pass (`prek run --all-files`)
18+
- [ ] Changes are added to the appropriate CHANGELOGs

.github/workflows/pr.yaml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: PR
2+
3+
on:
4+
pull_request_target:
5+
types:
6+
- opened
7+
- edited
8+
- reopened
9+
10+
jobs:
11+
lint:
12+
name: Lint
13+
runs-on: ubuntu-latest
14+
permissions:
15+
pull-requests: read
16+
steps:
17+
- uses: amannn/action-semantic-pull-request@v6
18+
env:
19+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.markdownlint-cli2.jsonc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@
99
"crates/*/examples/README.md",
1010
"target/**/*.md",
1111
"LICENSE-*",
12+
".github/pull_request_template.md",
1213
],
1314
}

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -76,29 +76,30 @@ $ rustac validate item.json
7676

7777
This monorepo contains several crates:
7878

79-
| Crate | Description | Badges |
80-
| ------------------------------------------------ | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
81-
| [stac](./crates/core/README.md) | Core data structures | [![docs.rs](https://img.shields.io/docsrs/stac?style=flat-square)](https://docs.rs/stac/latest/stac/) <br> [![Crates.io](https://img.shields.io/crates/v/stac?style=flat-square)](https://crates.io/crates/stac) |
82-
| [stac-io](./crates/io/README.md) | Input and output | [![docs.rs](https://img.shields.io/docsrs/stac-io?style=flat-square)](https://docs.rs/stac-io/latest/stac_io/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-io?style=flat-square)](https://crates.io/crates/stac-io) |
83-
| [stac-extensions](./crates/extensions/README.md) | Basic support for [STAC extensions](https://stac-extensions.github.io/) | [![docs.rs](https://img.shields.io/docsrs/stac-extensions?style=flat-square)](https://docs.rs/stac-extensions/latest/stac_extensions/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-extensions?style=flat-square)](https://crates.io/crates/stac-extensions) |
84-
| [rustac](./crates/cli/README.md) | Command line interface | [![docs.rs](https://img.shields.io/docsrs/rustac?style=flat-square)](https://docs.rs/rustac/latest/rustac/) <br> [![Crates.io](https://img.shields.io/crates/v/rustac?style=flat-square)](https://crates.io/crates/rustac) |
85-
| [stac-server](./crates/server/README.md) | STAC API server with multiple backends | [![docs.rs](https://img.shields.io/docsrs/stac-server?style=flat-square)](https://docs.rs/stac-server/latest/stac_server/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-server?style=flat-square)](https://crates.io/crates/stac-server) |
86-
| [pgstac](./crates/pgstac/README.md) | Bindings for [pgstac](https://github.com/stac-utils/pgstac) | [![docs.rs](https://img.shields.io/docsrs/pgstac?style=flat-square)](https://docs.rs/pgstac/latest/pgstac/) <br> [![Crates.io](https://img.shields.io/crates/v/pgstac?style=flat-square)](https://crates.io/crates/pgstac) |
87-
| [stac-duckdb](./crates/duckdb/README.md) | Experimental client for [duckdb](https://duckdb.org/) | [![docs.rs](https://img.shields.io/docsrs/stac-duckdb?style=flat-square)](https://docs.rs/stac-duckdb/latest/stac_duckdb/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-duckdb?style=flat-square)](https://crates.io/crates/stac-duckdb) |
79+
| Crate | Description | Badges |
80+
| ------------------------------------------------ | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
81+
| [stac](./crates/core/README.md) | Core data structures | [![docs.rs](https://img.shields.io/docsrs/stac?style=flat-square)](https://docs.rs/stac/latest/stac/) <br> [![Crates.io](https://img.shields.io/crates/v/stac?style=flat-square)](https://crates.io/crates/stac) |
82+
| [stac-io](./crates/io/README.md) | Input and output | [![docs.rs](https://img.shields.io/docsrs/stac-io?style=flat-square)](https://docs.rs/stac-io/latest/stac_io/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-io?style=flat-square)](https://crates.io/crates/stac-io) |
83+
| [stac-extensions](./crates/extensions/README.md) | Basic support for [STAC extensions](https://stac-extensions.github.io/) | [![docs.rs](https://img.shields.io/docsrs/stac-extensions?style=flat-square)](https://docs.rs/stac-extensions/latest/stac_extensions/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-extensions?style=flat-square)](https://crates.io/crates/stac-extensions) |
84+
| [stac-server](./crates/server/README.md) | STAC API server with multiple backends | [![docs.rs](https://img.shields.io/docsrs/stac-server?style=flat-square)](https://docs.rs/stac-server/latest/stac_server/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-server?style=flat-square)](https://crates.io/crates/stac-server) |
85+
| [pgstac](./crates/pgstac/README.md) | Bindings for [pgstac](https://github.com/stac-utils/pgstac) | [![docs.rs](https://img.shields.io/docsrs/pgstac?style=flat-square)](https://docs.rs/pgstac/latest/pgstac/) <br> [![Crates.io](https://img.shields.io/crates/v/pgstac?style=flat-square)](https://crates.io/crates/pgstac) |
86+
| [stac-duckdb](./crates/duckdb/README.md) | Search **stac-geoparquet** with [duckdb](https://duckdb.org/) | [![docs.rs](https://img.shields.io/docsrs/stac-duckdb?style=flat-square)](https://docs.rs/stac-duckdb/latest/stac_duckdb/) <br> [![Crates.io](https://img.shields.io/crates/v/stac-duckdb?style=flat-square)](https://crates.io/crates/stac-duckdb) |
87+
| [rustac](./crates/cli/README.md) | Command line interface | [![docs.rs](https://img.shields.io/docsrs/rustac?style=flat-square)](https://docs.rs/rustac/latest/rustac/) <br> [![Crates.io](https://img.shields.io/crates/v/rustac?style=flat-square)](https://crates.io/crates/rustac) |
8888

8989
### Dependency relationships
9090

9191
```mermaid
9292
graph TD
9393
stac --> stac-io
9494
stac --> stac-extensions
95-
stac --> rustac
9695
stac --> pgstac
9796
stac --> stac-duckdb
9897
stac --> stac-server
98+
pgstac -.-> stac-server
99+
stac-duckdb -.-> stac-server
100+
stac --> rustac
99101
stac-io --> rustac
100-
pgstac --> stac-server
101-
stac-duckdb --> stac-server
102+
stac-duckdb --> rustac
102103
stac-server --> rustac
103104
```
104105

0 commit comments

Comments
 (0)