accountill icon indicating copy to clipboard operation
accountill copied to clipboard

Enhancement Proposal: Implementing Templates for Feature Requests, Bug Reports, and Pull Requests

Open kmalap05 opened this issue 1 year ago • 0 comments

Suggestion: Issue Templates for Feature Requests, Bug Reports and Pull Requests

I propose adding issue templates for feature requests and bug reports to enhance the issue tracking process. Below are template examples for both types of issues:

  • Feature Request Template:

    ---
    name: Feature Request
    about: Suggest a new idea or improvement
    ---
    
    **Describe the Feature Request**
    A clear and concise description of the feature you are proposing.
    
    **Why do you believe this feature is necessary?**
    Explain the problem or opportunity that this feature addresses.
    
    **Additional context**
    Add any other context or screenshots about the feature request here.
    
  • Bug Report Template:

    ---
    name: Bug Report
    about: Report a bug to help us improve
    ---
    
    **Describe the Bug**
    A clear and concise description of what the bug is.
    
    **To Reproduce**
    Steps to reproduce the behavior:
    
    1. Go to '...'
    2. Click on '....'
    3. Scroll down to '....'
    4. See error
    
    **Expected Behavior**
    A clear and concise description of what you expected to happen.
    
    **Screenshots**
    If applicable, add screenshots to help explain your problem.
    
    **Environment (please complete the following information):**
     - OS: [e.g., iOS]
     - Browser: [e.g., Chrome, Firefox]
     - Version: [e.g., 22]
    
    **Additional context**
    Add any other context about the problem here.
    

These templates aim to collect information in a structured manner, making it easier for contributors to submit issues effectively. It can provide a smoother issue tracking experience.

  • Pull Request Template:
    ---
    name: Pull Request
    about: Submit changes for review
    ---
    
    **Description**
    Provide a brief description of the changes introduced by this pull request.
    
    **Related Issue**
    If there is an issue associated with this pull request, please reference it here.
    
    **Type of Change**
    - [ ] Bug fix
    - [ ] New feature
    - [ ] Enhancement
    - [ ] Documentation update
    
    **Checklist:**
    - [ ] I have tested my changes thoroughly.
    - [ ] My code follows the project's coding standards.
    - [ ] I have added unit tests if applicable.
    - [ ] Documentation is updated to reflect the changes.
    
    **Additional context**
    Add any additional context or information that would be helpful for reviewers.
    
    **Screenshots**
    If applicable, include screenshots or gifs showcasing the changes made.
    
    **Reviewer Notes**
    Any specific instructions for the reviewer or areas of focus.
    

This PR template aims to guide contributors in providing essential information for effective code review. Consider adding it to streamline the contribution process. Thank you!

kmalap05 avatar Jan 03 '24 18:01 kmalap05