Update CONTRIBUTING.md tools and workflows#91
Conversation
Expand and clarify development docs: add Conda, Codecov, Ruff, and quartodoc to tools; document gh-pages branch and CHANGELOG.md; note Copilot in code review. Reformat development workflow items to bullets, adjust CI/testing section (replace some specific coverage/benchmark entries with a generic Performance Tests item), and tidy repository/issue/pull request guidance. Remove an explicit Security subsection and make small editorial fixes for consistency.
There was a problem hiding this comment.
Pull request overview
This PR updates CONTRIBUTING.md to better reflect the project's current development tools and workflows while improving document organization and clarity.
Changes:
- Added current tools (Conda, Codecov, Ruff, quartodoc) to the "Tools Used in This Project" section with descriptions
- Documented the gh-pages branch and CHANGELOG.md file in the repository organization section
- Noted GitHub Copilot's role in the code review process
- Reorganized Development Workflow from numbered list to bullets, streamlined CI/CD testing descriptions, and removed redundant Security subsection
- Added blank lines after section headers throughout for improved readability
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - **quartodoc**: Quarto extension for documentation sites | ||
| - Provides templates and tools for building documentation websites |
There was a problem hiding this comment.
The description of quartodoc is inaccurate. quartodoc is not primarily a "Quarto extension for documentation sites" that provides "templates and tools for building documentation websites". Instead, it's a tool for automatically generating API reference documentation from Python docstrings specifically for Quarto websites. It generates API documentation pages from your Python code's docstrings, similar to how Sphinx autodoc works for Sphinx documentation.
| - **quartodoc**: Quarto extension for documentation sites | |
| - Provides templates and tools for building documentation websites | |
| - **quartodoc**: Tool for generating API reference documentation for Quarto sites | |
| - Automatically creates API documentation pages from Python docstrings |
Expand and clarify development docs: add Conda, Codecov, Ruff, and quartodoc to tools; document gh-pages branch and CHANGELOG.md; note Copilot in code review. Reformat development workflow items to bullets, adjust CI/testing section (replace some specific coverage/benchmark entries with a generic Performance Tests item), and tidy repository/issue/pull request guidance. Remove an explicit Security subsection and make small editorial fixes for consistency.