Skip to content

feat: improve contributor workflow with GitHub issue forms and PR template#159

Open
charantejguniganti wants to merge 1 commit into
PSMRI:mainfrom
charantejguniganti:feature/github-templates
Open

feat: improve contributor workflow with GitHub issue forms and PR template#159
charantejguniganti wants to merge 1 commit into
PSMRI:mainfrom
charantejguniganti:feature/github-templates

Conversation

@charantejguniganti
Copy link
Copy Markdown

@charantejguniganti charantejguniganti commented May 12, 2026

📝 Description

JIRA ID: N/A

This PR introduces standardized GitHub issue forms and improves the contribution workflow for the AMRIT ecosystem. The current workflow lacked structured issue reporting, making it harder for contributors to provide clear information and for maintainers to triage issues and review PRs efficiently. These additions address that directly.

Changes Added:

  • Added bug_report.yml issue form
  • Added feature_request.yml issue form
  • Added documentation_improvement.yml issue form
  • Added .github/ISSUE_TEMPLATE/config.yml
  • Improved pull request workflow consistency
  • Added screenshot section support in PR template

✅ Type of Change

  • New feature (non-breaking change which adds functionality)
  • 📘 Documentation (updates to docs or readme)
  • 🧹 Chore (miscellaneous workflow/configuration improvements)

ℹ️ Additional Information

Testing Performed:

  • Verified GitHub Issue Forms render correctly
  • Verified dropdowns, validations, and required fields work as expected
  • Confirmed template visibility under "New Issue"
  • Confirmed config.yml behavior works as expected
  • Verified PR template renders correctly during PR creation

Demo / Walkthrough

A short walkthrough video has been included demonstrating:

  • GitHub Issue Form rendering
  • Bug report workflow
  • Feature request workflow
  • Documentation issue workflow
  • Pull request template preview
  • Contributor experience improvements
github_templates_preview_1778611577333

This helps validate the new contribution workflow and template behavior.

Summary by CodeRabbit

Release Notes

  • Chores
    • Established structured GitHub issue templates for bug reports, feature requests, and documentation improvements.
    • Added pull request template to guide contributor submissions.
    • Configured issue settings to direct users to community discussions.

Review Change Stack

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented May 12, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3f8ead23-feb6-4f07-aded-b6d15679964d

📥 Commits

Reviewing files that changed from the base of the PR and between 4f3a2f6 and a980915.

📒 Files selected for processing (5)
  • .github/ISSUE_TEMPLATE/bug_report.yml
  • .github/ISSUE_TEMPLATE/config.yml
  • .github/ISSUE_TEMPLATE/documentation_improvement.yml
  • .github/ISSUE_TEMPLATE/feature_request.yml
  • .github/pull_request_template.md

📝 Walkthrough

Walkthrough

This PR establishes structured GitHub contributor templates for the AMRIT repository. It adds issue templates for bug reports, feature requests, and documentation improvements—each with component selection and required fields—configures issue template settings, and introduces a comprehensive pull request template with change type, component impact, and review checklist sections.

Changes

GitHub Contributor Templates

Layer / File(s) Summary
Issue template configuration
.github/ISSUE_TEMPLATE/config.yml
Disables blank issue creation and adds a contact link to AMRIT Discussions for general questions.
Bug Report issue template
.github/ISSUE_TEMPLATE/bug_report.yml
Structured form collecting AMRIT component selection, required bug description and reproduction steps, required expected behavior, and optional environment and log output details.
Feature Request issue template
.github/ISSUE_TEMPLATE/feature_request.yml
Structured form with component dropdown, required problem and solution descriptions, and optional alternatives and additional context; applies enhancement and triage labels.
Documentation Improvement issue template
.github/ISSUE_TEMPLATE/documentation_improvement.yml
Structured form requesting documentation location selection, required improvement description, optional proposed changes and relevant links; applies documentation and triage labels.
Pull Request template
.github/pull_request_template.md
Comprehensive template sections: PR description and issue linkage, type of change (bug fix, feature, breaking change, docs), affected AMRIT components, development checklist (style, review, tests, docs, warnings), optional screenshots, and additional context.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 Templates bloom in GitHub's garden,
Structured forms that seek forgiveness's pardon,
Bug reports clear, features sing,
PRs guided with checkboxes' wing,
Contributors now know the path to take! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title directly and accurately summarizes the main change: introducing GitHub issue forms and PR template to improve the contributor workflow.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Tip

💬 Introducing Slack Agent: The best way for teams to turn conversations into code.

Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.

  • Generate code and open pull requests
  • Plan features and break down work
  • Investigate incidents and troubleshoot customer tickets together
  • Automate recurring tasks and respond to alerts with triggers
  • Summarize progress and report instantly

Built for teams:

  • Shared memory across your entire org—no repeating context
  • Per-thread sandboxes to safely plan and execute work
  • Governance built-in—scoped access, auditability, and budget controls

One agent for your entire SDLC. Right inside Slack.

👉 Get started


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.

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant