Enhance documentation for contributing new checks #546
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Added a new guide on contributing checks to NWBInspector in `contributing_checks.rst`. - Updated `developer_guide.rst` to reference the new contributing checks guide. - Modified `.gitignore` to exclude additional build artifacts. This update aims to streamline the contribution process and improve clarity for new contributors.
for more information, see https://pre-commit.ci
- Updated `contributing_checks.rst` to improve clarity and consistency by replacing inline code formatting with Sphinx directives for better readability. - Added a new `Makefile` to facilitate Sphinx documentation building, providing a minimal setup for users to generate documentation easily.
for more information, see https://pre-commit.ci
Co-authored-by: Steph Prince <[email protected]>
Co-authored-by: Steph Prince <[email protected]>
Co-authored-by: Steph Prince <[email protected]>
for more information, see https://pre-commit.ci
Co-authored-by: Steph Prince <[email protected]>
for more information, see https://pre-commit.ci
Co-authored-by: Steph Prince <[email protected]>
for more information, see https://pre-commit.ci
stephprince
reviewed
Jan 13, 2025
stephprince
approved these changes
Jan 13, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
contributing_checks.rst.developer_guide.rstto reference the new contributing checks guide..gitignoreto exclude additional build artifacts.This update aims to streamline the contribution process and improve clarity for new contributors.