Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

GitHub Configuration

The .github folder in this repository contains GitHub configurations such as Issue Templates and a Pull Request template.

Issue Templates

Available Templates:

  • Bug Report (bug_report.md)
  • Feature Request (feature_request.md)
  • Documentation Request (documentation_request.md)
  • Support (support_request.md)
  • Refactor (refactor_request.md)

Shared Sections

Templates share these sections:

  • Overview: A brief summary of the issue.
  • Details: Background, context, or rationale.
  • Proposed Actions: Suggested tasks or steps.
  • Acceptance Criteria: Define "done" or success.
  • Additional Info: Links, logs, or references.

Creating an Issue

  1. Click New Issue.
  2. Select a template.
  3. Fill out and submit.

Pull Request Template

Structure

The pull_request_template.md contains:

  • Overview: Change summary.
  • Details: Context for the change.
  • Testing and Validation: How to verify the change.
  • Checklist: Pre-merge checks.
  • Additional Info: Links or screenshots.

Using the Template

  • Open a pull request.
  • Complete all sections to help reviewers.

Best Practices

  • Descriptive Filenames: Ensure clarity in naming.
  • Appropriate Labels: Use labels for triaging.
  • Keep Docs Updated: Reflect all changes in this README.