Skip to content

Conversation

aditi25srivastava
Copy link

@aditi25srivastava aditi25srivastava commented Oct 3, 2025

Hello, @M4dhav

-> Project Title:
Issue Template and Configuration Improvements for Resonate-Backend
->. Mentor:- @M4dhav

-> By:
Aditi Srivastava

-> Overview

This PR adds and corrects the Issue and Pull Request templates for the Resonate Backend repository to achieve feature
parity with the Frontend repo and fix all validation errors flagged by reviewers and GitHub bots.

-> Introduction

1.	Confusing Template Directory Structure:
2. 
•	Previous issue and PR templates were scattered or mislocated in non-standard subdirectories.
•	Prevented proper auto-detection and use by GitHub’s issue/pr forms.

3.	Frequent YAML Formatting Errors:
•	Indentation and spacing issues caused validation errors and worsened contributor experience.
•	Fixed to conform to GitHub’s YAML schema, making reporting bugs or feature requests smooth.

4.	Missing Unique IDs and Required Attributes:
•	Form fields often lacked necessary IDs, causing schema failures and poor organization.
•	Now each textarea and checkbox field is clearly identified and unique.

5.	Broken Content and Invalid Links:
•	Some templates contained incorrect URLs or formatting, reducing usability and clarity for users.
•	All links and content have been audited for correctness.

6.	Enhanced Contributor Experience:
•	By standardizing templates and directory structure, all contributors now benefit from consistent and error-free issue and PR forms. 

-> Solutions

1.	Standardize Template Directory Structure:
2. 
•	Relocated all issue and PR templates into the  .github/ISSUE_TEMPLATE/  directory.
•	Removed unused or ignored subdirectories to ensure templates are always auto-detected.

3.	Consistent YAML Formatting and Indentation:
•	Fixed spacing and indentation errors across all YAML templates.
•	Applied GitHub’s best practices for issue form schema to ensure error-free submission.

4.	Add Unique Field Identifiers:
•	Introduced mandatory unique IDs for all textarea and checkbox fields in templates.
•	Enforced consistency and traceability for all user submissions.

5.	Correct All Content & Links:
•	Checked and fixed broken, duplicate, or invalid URLs in all templates.
•	Improved labels and instructions for clearer communication and user guidance.

7.	Enhance Contributor Experience:
•	Standardized all template layouts for predictable contributor workflow.
•	Made the bug/feature request/reporting process intuitive, clear, and reliable.

-> Files and Fixes Summary

 1. Template Directory Structure
•	Moved all templates into  .github/ISSUE_TEMPLATE/  directory.
•	Removed invalid  .md  subdirectory that GitHub ignores.

 2. YAML Formatting Fixes
•	Corrected indentation under  body:  in all templates ( bug_report.yml ,  documentation_issue.yml ,                   feature_request.yml ,  re-implementation.yml ,  refactor-to-enhance.yml ,  security_improvement.yml ).  
•	Ensured all list entries and nested keys are indented 2 spaces as required by GitHub Issue form schema.

  3. Unique  id  Properties Added
•	Added missing mandatory  id:  fields for all  textarea  and  checkboxes  form fields.
•	Examples:  id: motivation ,  id: security-focus-areas ,  id: refactor-to-enhance , etc.
•	IDs are consistent and unique per field.

 4. Content Corrections
•	Fixed extra URL slashes and improper links in  bug_report.yml  and  documentation_issue.yml .
•	Verified all labels, descriptions, and validation flags reflect project standards.

  5. Validation & Testing
•	Validated YAML syntax for each template.
•	Tested rendering and functionality on GitHub preview.

-> Files Checked and Fixed

1•	 bug_report.yml 
•	Originally flagged for URL and indentation fixes.

2•	 documentation_issue.yml 
•	Reviewer requested spacing and unique  id .

3•	 feature_request.yml ,  re-implementation.yml 
•	Added missing  id  keys for textareas; corrected indentation (already fixed).

4•	 refactor-to-enhance.yml 
•	Added missing  id  for checkboxes and textarea (already fixed).

5•	 security_improvement.yml 
•	Added missing  id  for textareas and checkboxes  Indentation checked (already fixed)

-> Documentation

1•	All YAML files validated for schema and usability
2•	URLs in  bug_report.yml  and  documentation_issue.yml  cleaned up
3•	No further changes were needed for some files due to prior fixes
4•	Directory structure now matches GitHub requirements

-> What Was Already Fixed

1•	Several issues mentioned by reviewers had been fixed before new comments even before some bot suggestions
2•	This PR clarifies which files were already resolved like  (feature_request.yml ,  re-implementation.yml , etc)

Thankyou !!!!!!

Summary by CodeRabbit

  • Documentation

    • Introduced standardized GitHub issue templates for Bug Report, Feature Request, Documentation Issue, Configuration Change, Re-implementation, Refactor to Enhance, and Security Improvement. Templates include required fields, guidance for clear reproduction steps, motivation, and optional focus-area checklists to improve report quality.
  • Chores

    • Added a pull request template to streamline contributions with sections for description, change type, testing details, and checklists for contributors and maintainers.

Copy link

coderabbitai bot commented Oct 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

Adds new GitHub repository templates: multiple issue forms under .github/ISSUE_TEMPLATE for bugs, documentation, features, refactors, re-implementations, security, and configuration changes; plus a pull request template at .github/PULL_REQUEST_TEMPLATE.md. All changes are YAML/Markdown configuration; no code or runtime logic modifications.

Changes

Cohort / File(s) Summary of Changes
Issue templates
.github/ISSUE_TEMPLATE/bug_report.yml, .github/ISSUE_TEMPLATE/configuration_change.yml, .github/ISSUE_TEMPLATE/documentation_issue.yml, .github/ISSUE_TEMPLATE/feature_request.yml, .github/ISSUE_TEMPLATE/re-implementation.yml, .github/ISSUE_TEMPLATE/refactor-to-enhance.yml, .github/ISSUE_TEMPLATE/security_improvement.yml
Introduces structured issue forms with labeled fields, required validations, guidance text, optional checkboxes, and closing thank-you markdown for respective categories.
Pull request template
/.github/PULL_REQUEST_TEMPLATE.md
Adds a standard PR template with sections for description, change type checkboxes, testing, contributor checklist, and maintainer checklist.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

I twitch my ears at tidy forms, hooray!
New issue burrows pave a clearer way.
PR paths are lined, checklists in bloom—
Hop, submit, review, vroom-vroom!
In YAML meadows, I leave my trace,
A rabbit shipping templates with grace. 🐇✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changes. Docstring coverage check skipped.
Title Check ✅ Passed The pull request title clearly and concisely summarizes the main changes by indicating that missing IDs are being added and issue templates are being restructured, which directly reflects the PR’s objectives of standardizing and correcting the GitHub templates.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 795f29b and 40cc6a9.

⛔ Files ignored due to path filters (2)
  • id_ed25519.pub is excluded by !**/*.pub
  • id_ed25519.pub.pub is excluded by !**/*.pub
📒 Files selected for processing (8)
  • .github/ISSUE_TEMPLATE/bug_report.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/configuration_change.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/documentation_issue.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/feature_request.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/re-implementation.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/refactor-to-enhance.yml (1 hunks)
  • .github/ISSUE_TEMPLATE/security_improvement.yml (1 hunks)
  • .github/PULL_REQUEST_TEMPLATE.md (1 hunks)

@M4dhav
Copy link
Contributor

M4dhav commented Oct 3, 2025

Hey @aditi25srivastava , please use a more descriptive name for the PR, "Pr 97" makes it hard to understand what the PR is about

@M4dhav
Copy link
Contributor

M4dhav commented Oct 4, 2025

Hey @aditi25srivastava , I meant, please change the name of this PR. Also, as a dev branch has been created please change the base for this PR to dev. Additionally, your PR contains commits from another contributor, please remove them.

@aditi25srivastava aditi25srivastava changed the title Pr 97 Fix: Add Missing IDs and Restructure Issue Templates Oct 4, 2025
@aditi25srivastava aditi25srivastava changed the base branch from main to dev October 4, 2025 14:13
@M4dhav M4dhav self-requested a review October 5, 2025 20:27
@M4dhav M4dhav self-assigned this Oct 5, 2025
@M4dhav M4dhav added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Oct 5, 2025
@M4dhav M4dhav linked an issue Oct 5, 2025 that may be closed by this pull request
Copy link
Contributor

@M4dhav M4dhav left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Waiting for commits from another contributor to be removed from PR, please re-request review when done

@aditi25srivastava
Copy link
Author

aditi25srivastava commented Oct 6, 2025

Heyyy!! @M4dhav I'm sorry for this actually, I am currently preparing for my exams, so I may need a little extra time to address the requested changes and ensure the PR is updated correctly. I’ll make the necessary updates as soon as possible after my exams are completed.......

@M4dhav
Copy link
Contributor

M4dhav commented Oct 18, 2025

Hey @aditi25srivastava , PR still contains commits from another contributor, you might want to create a fresh branch, cherry pick your commits to that branch and open a fresh PR from there

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Issue and PR Templates similar to Resonate Frontend Repo

3 participants