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

DOC: add links to ComPWA/repo-maintenance #214

Merged
merged 3 commits into from
Oct 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions docs/adr/002/composition.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -366,8 +366,7 @@
"class DynamicsBuilder(Protocol):\n",
" def __call__(\n",
" self, graph: StateTransitionGraph, edge_id: int\n",
" ) -> DynamicsExpression:\n",
" ..."
" ) -> DynamicsExpression: ..."
]
},
{
Expand Down
31 changes: 20 additions & 11 deletions docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <develop:Issue management>` or a
{ref}`pull request <develop:Collaboration>` 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 <develop:Issue
management>` or a {ref}`pull request <develop:Collaboration>` 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

Expand Down Expand Up @@ -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 <develop:GitHub Actions>`, as well as a check on
{ref}`PR labels <develop:Issue management>` (see overview
{ref}`enforced through GitHub Actions <develop:GitHub Actions>` with
[`commitlint`](https://github.com/conventional-changelog/commitlint), as well as a
check on {ref}`PR labels <develop:Issue management>` (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
Expand All @@ -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 <develop:Release flow>`!

<!-- prettier-ignore-start -->
[^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.
<!-- prettier-ignore-end -->

### Release flow
Expand Down
Loading