diff --git a/docs/adr/002/composition.ipynb b/docs/adr/002/composition.ipynb index 86c7c098..6a877974 100644 --- a/docs/adr/002/composition.ipynb +++ b/docs/adr/002/composition.ipynb @@ -366,8 +366,7 @@ "class DynamicsBuilder(Protocol):\n", " def __call__(\n", " self, graph: StateTransitionGraph, edge_id: int\n", - " ) -> DynamicsExpression:\n", - " ..." + " ) -> DynamicsExpression: ..." ] }, { diff --git a/docs/develop.md b/docs/develop.md index 8ed54814..961f01f8 100644 --- a/docs/develop.md +++ b/docs/develop.md @@ -353,11 +353,17 @@ commit files locally (see {ref}`develop:Pre-commit`), when The tools are mainly configured through [`pyproject.toml`](https://github.com/ComPWA/ampform/blob/main/pyproject.toml), [`tox.ini`](https://github.com/ComPWA/ampform/blob/main/tox.ini), and the workflow files -under [`.github`](https://github.com/ComPWA/ampform/blob/main/.github). If you run into -persistent linting errors, this may mean we need to further specify our conventions. In -that case, it's best to {ref}`create an issue ` or a -{ref}`pull request ` and propose a policy change that can be -formulated through those config files. +under [`.github`](https://github.com/ComPWA/ampform/blob/main/.github). These +configuration files are kept up to date through the +[ComPWA/repo-maintenance](https://compwa.github.io/repo-maintenance) repository, which +essentially defines the developer environment across [all ComPWA +repositories](https://github.com/orgs/ComPWA/repositories?q=archived%3Ano&type=all&language=&sort=name). + +If you run into persistent linting errors, this may mean we need to further specify our +conventions. In that case, it's best to {ref}`create an issue ` or a {ref}`pull request ` at +[ComPWA/repo-maintenance](https://github.com/ComPWA/repo-maintenance) and propose a +policy change that can be formulated through those config files. ### Pre-commit @@ -851,11 +857,12 @@ not have any CI or code review restrictions. We call this a "feature branch". patches between the minor and major releases. Note that a conventional commit message style is - {ref}`enforced through GitHub Actions `, as well as a check on - {ref}`PR labels ` (see overview + {ref}`enforced through GitHub Actions ` with + [`commitlint`](https://github.com/conventional-changelog/commitlint), as well as a + check on {ref}`PR labels ` (see example [here](https://github.com/ComPWA/ampform/actions?query=workflow%3A%22PR+linting%22)). - The corresponding configuration file is - [`commitlint.config.js`](https://github.com/ComPWA/ampform/blob/main/commitlint.config.js). + The commit messages are centrally defined for the ComPWA organization at + [ComPWA/commitlint-config](https://github.com/ComPWA/commitlint-config). - PRs can only be merged through 'squash and merge'. There, you will see a summary based on the separate commits that constitute this PR. Leave the relevant commits in as @@ -864,8 +871,10 @@ not have any CI or code review restrictions. We call this a "feature branch". comes in especially handy when {ref}`drafting a release `! -[^1]: See [ComPWA/.github#7](https://github.com/ComPWA/.github/issues/7) for a - discussion on these commit types. +[^1]: The commit types for the ComPWA organization are defined + [here](https://github.com/ComPWA/commitlint-config/blob/main/index.js). See also + [ComPWA/.github#7](https://github.com/ComPWA/.github/issues/7) for a discussion on + these commit types. ### Release flow