Skip to content

[Docs] Add developer tutorial for pre-commit and formal issue templates #46

Description

@keli-wen

Problem

The repository's README currently lacks a standard developer setup tutorial, specifically instructions on setting up and using pre-commit hooks. Additionally, there are no formal issue templates to guide contributors when opening bug reports or feature requests.

Proposed Changes

  • Add a Dev Setup section in the README with:

    • Steps to install and configure pre-commit hooks
    • Instructions for running hooks locally and in CI
    • Example commands and troubleshooting tips
  • Introduce ISSUE_TEMPLATEs in .github/ISSUE_TEMPLATE/:

    • bug_report.md for bug reporting
    • feature_request.md for feature suggestions
    • Include appropriate labels, checklists, and structured sections in each template

Benefits

  • Standardizes development workflows across the project
  • Reduces onboarding friction for new contributors
  • Ensures consistency and completeness in issue reports

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Type

No fields configured for Task.

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions