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.

Sign up for GitHub

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

Jump to bottom

Add developer guide in docs #232

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

Add developer guide in docs #232

wants to merge 4 commits into from

Conversation

yasahi-hpc
Copy link
Collaborator

@yasahi-hpc yasahi-hpc commented Feb 25, 2025 •
edited
Loading

This PR aims at adding a developer guide in the documentation.

The developer guide includes

  • The basic procedure to contribute this project
  • Description of our review procedures
  • Details of our CI: formatting (see discussions in Introduce cmake-format in CI #229), build and unit-tests
  • Best practice for docstrings in the source codes
  • Apply format to CMakeLists.txt for docs

@yasahi-hpc yasahi-hpc self-assigned this Feb 25, 2025
@yasahi-hpc yasahi-hpc added documentation Improvements or additions to documentation enhancement New feature or request labels Feb 25, 2025
@yasahi-hpc yasahi-hpc marked this pull request as draft February 25, 2025 15:36
@yasahi-hpc yasahi-hpc marked this pull request as ready for review February 26, 2025 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@yasahi-hpc yasahi-hpc

Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@yasahi-hpc