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

Docs: improve "Workflows" section for developers #5525

Open
wants to merge 8 commits into
base: development
Choose a base branch
from

Conversation

EZoni
Copy link
Member

@EZoni EZoni commented Dec 20, 2024

Suggestion for reviewers:
Compare the preview of the new documentation available from the CI check docs/readthedocs.org:warpx with the existing documentation available online.

Improve the Workflows documentation for developers, so far only the following sections:

  • "How to test the code"
  • "How to run the clang-tidy linter"

To-do:

  • Incorporate minimal checksum documentation in one single test section
  • Add step-by-step guide on how to add new tests (enumerated list of steps)

@EZoni EZoni added component: documentation Docs, readme and manual component: tests Tests and CI labels Dec 20, 2024
@EZoni EZoni changed the title [WIP] Improve "Workflows" docs for developers, simplify addition of new CI tests [WIP] Docs: improve "Workflows" section for developers Dec 20, 2024
@ax3l ax3l self-requested a review January 2, 2025 23:07
@EZoni EZoni marked this pull request as ready for review January 9, 2025 22:12
@EZoni EZoni requested a review from aeriforme January 9, 2025 22:12
@EZoni EZoni changed the title [WIP] Docs: improve "Workflows" section for developers Docs: improve "Workflows" section for developers Jan 9, 2025
Copy link
Member Author

@EZoni EZoni Jan 9, 2025

Choose a reason for hiding this comment

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

FYI, this file was actually renamed from run_clang_tidy_locally.rst and modified later on, but the number of changes is large enough to make GitHub display it as a new file.

@ax3l ax3l self-assigned this Jan 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component: documentation Docs, readme and manual component: tests Tests and CI
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants