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

Add CI #5

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Open

Add CI #5

wants to merge 12 commits into from

Conversation

duboism
Copy link
Contributor

@duboism duboism commented Jan 15, 2025

This PR adds CI rules. This is done to enforce some of the contributions guidelines. This partially addresses #4.

The rules are strongly inspired by the ones created by Gregory Ashton for ODW 2023. To acknowledge that, a file listing contributions was added (see Contributors.md).

What is checked?

The followings items are checked:

  • ensure that the code in the notebook runs
  • ensure that cells are run in order
  • ensure that notebooks don't install packages that are not in the conda environment
  • ensure that there is no spelling mistakes in the files

When are the rules applied?

The rules are applied when pushing on the main branch or before merging PR. They can also be run on-demand.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant