Skip to content

add CI description to contributing guide#13837

Draft
CarinaFo wants to merge 1 commit intomne-tools:mainfrom
CarinaFo:update_contributing
Draft

add CI description to contributing guide#13837
CarinaFo wants to merge 1 commit intomne-tools:mainfrom
CarinaFo:update_contributing

Conversation

@CarinaFo
Copy link
Copy Markdown
Contributor

@CarinaFo CarinaFo commented Apr 11, 2026

This PR updates the Contributing Guide to improve clarity and usability of the CI (Continuous Integration) section.

The current contributing guide links to a Wikipedia page on CI but does not explain why we use CI.

This update aims to make it easier for new contributors to:

Understand what CI is doing and why it is important to run checks locally before pushing changes. This is particularly relevant, as we receive many user comments about CircleCI and failing doc builds for unregistered users.

@CarinaFo CarinaFo marked this pull request as draft April 11, 2026 06:35
@CarinaFo CarinaFo force-pushed the update_contributing branch from 4ea778c to b1b8b9e Compare April 11, 2026 08:58
@CarinaFo
Copy link
Copy Markdown
Contributor Author

CI failure seems unrelated (PyVista/VTK on Python 3.13).

jobs do not start automatically, or appear as "pending".

This is expected behavior. CircleCI requires **manual approval from a
maintainer** before running jobs submitted by new contributors. This is a
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actually I think CircleCI you just need to create an account linked to your GitHub

GHA is the one we have to manually approve for new contributors

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, will look into that further. We recently had a user having trouble with CircelCI tests even after signing up with linked github account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants