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: update links to compwa.github.io #285

Merged
merged 1 commit into from
Jan 20, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/sync-labels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
labels sync --filename labels/default.toml --owner ComPWA --repo RUB-EP1-AG
labels sync --filename labels/default.toml --owner ComPWA --repo ampform
labels sync --filename labels/default.toml --owner ComPWA --repo benchmarks
labels sync --filename labels/default.toml --owner ComPWA --repo compwa-org
labels sync --filename labels/default.toml --owner ComPWA --repo compwa.github.io
labels sync --filename labels/default.toml --owner ComPWA --repo policy
labels sync --filename labels/default.toml --owner ComPWA --repo qrules
labels sync --filename labels/default.toml --owner ComPWA --repo sphinxcontrib-hep-pdgref
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

This repository sets the policies for developer environment in repositories if the [ComPWA organization](https://github.com/ComPWA) (See our [Help developing](https://compwa-org.readthedocs.io/develop.html) page). The policies are automatically enforced through [pre-commit](https://pre-commit.com).
This repository sets the policies for developer environment in repositories if the [ComPWA organization](https://github.com/ComPWA) (See our [Help developing](https://compwa.github.io/develop) page). The policies are automatically enforced through [pre-commit](https://pre-commit.com).

## Usage

Expand Down
2 changes: 1 addition & 1 deletion docs/check-dev-files.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `check-dev-files`

This hook is responsible for standardizing and synchronizing the [developer environment](https://compwa-org.rtfd.io/develop.html) of repositories by the [ComPWA organization](https://github.com/ComPWA). Coding conventions are enforced through automated checks instead of through a contribution guide. These conventions have to be regularly updated across all repositories as developer tools introduce new features and deprecate old ones.
This hook is responsible for standardizing and synchronizing the [developer environment](https://compwa.github.io/develop) of repositories by the [ComPWA organization](https://github.com/ComPWA). Coding conventions are enforced through automated checks instead of through a contribution guide. These conventions have to be regularly updated across all repositories as developer tools introduce new features and deprecate old ones.

The `check-dev-files` hook can also be used as a **cookie cutter** for new repositories by adding the following to your [`.pre-commit-config.yaml`](https://pre-commit.com/index.html#adding-pre-commit-plugins-to-your-project) file:

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,5 +47,5 @@ check-dev-files
API <api/compwa_policy>
Changelog <https://github.com/ComPWA/policy/releases>
Upcoming features <https://github.com/ComPWA/policy/milestones?direction=asc&sort=title&state=open>
Help developing <https://compwa-org.rtfd.io/develop.html>
Help developing <https://compwa.github.io/develop>
```
2 changes: 1 addition & 1 deletion src/compwa_policy/pin_nb_requirements.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
"""Enforce adding a pip install statement in the notebook.

In the `compwa-org repo <https://github.com/ComPWA/compwa-org>`_, notebooks
In the `compwa.github.io repo <https://github.com/ComPWA/compwa.github.io>`_, notebooks
should specify which package versions should be used to run the notebook. This
hook checks whether a notebook has such install statements and whether they
comply with the expected formatting.
Expand Down
Loading