Skip to content

docs: Update issue template with pre-commit documentation#2157

Merged
exploreriii merged 3 commits into
hiero-ledger:mainfrom
freya-docs:update-issue-template
Apr 17, 2026
Merged

docs: Update issue template with pre-commit documentation#2157
exploreriii merged 3 commits into
hiero-ledger:mainfrom
freya-docs:update-issue-template

Conversation

@freya-docs

Copy link
Copy Markdown
Contributor

Description:
This PR will update Good First Issue templates with with pre-commit documentation.

Related issue(s):

Fixes #2139

Added a checklist item for setting up pre-commit hooks to the issue template.

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
Added a checklist item for setting up pre-commit hooks to ensure code quality and formatting.

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
@freya-docs
freya-docs requested review from a team as code owners April 16, 2026 18:01
@coderabbitai

coderabbitai Bot commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro

Run ID: 808f16ae-04ff-446a-9f41-d191165d7666

📥 Commits

Reviewing files that changed from the base of the PR and between 93a8f44 and e4e2da3.

📒 Files selected for processing (2)
  • .github/ISSUE_TEMPLATE/00-good-first-issue-candidate.yml
  • .github/ISSUE_TEMPLATE/01-good-first-issue.yml

Walkthrough

Two GitHub issue template YAML files were updated to include pre-commit hook setup requirements in both the setup steps section and the PR quality checklist to document this requirement for new contributors.

Changes

Cohort / File(s) Summary
GitHub Issue Templates
.github/ISSUE_TEMPLATE/00-good-first-issue-candidate.yml, .github/ISSUE_TEMPLATE/01-good-first-issue.yml
Added checklist items requiring contributors to set up pre-commit hooks in the setup steps section and added a PR quality checklist requirement confirming installation and execution of pre-commit hooks for code quality and formatting.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: updating issue templates with pre-commit documentation, which directly matches the PR's primary objective.
Description check ✅ Passed The description is related to the changeset, stating that it updates Good First Issue templates with pre-commit documentation and references the linked issue #2139.
Linked Issues check ✅ Passed The PR successfully adds pre-commit documentation requirements to both required YAML files with setup instructions and PR quality checklist items as specified in issue #2139.
Out of Scope Changes check ✅ Passed All changes are strictly limited to the two required YAML issue template files with no unrelated modifications present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

📋 Issue Planner

Built with CodeRabbit's Coding Plans for faster development and fewer bugs.

View plan used: #2139

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

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.

@codacy-production

codacy-production Bot commented Apr 16, 2026

Copy link
Copy Markdown

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

TIP This summary will be updated as you push new changes. Give us feedback

@exploreriii exploreriii left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you! Great idea

@exploreriii exploreriii added step: 2nd second stage of the review approval process reviewer: write requires a review with write permissions labels Apr 16, 2026
@github-actions github-actions Bot added the Good First Issue Issues which are ideal for a first time or new project contributor. label Apr 17, 2026
@exploreriii

Copy link
Copy Markdown
Contributor

Update branch please @freya-docs

@exploreriii exploreriii added step: merge ready PR is ready and waiting to merge status: update branch developer needs to click update branch and removed step: 2nd second stage of the review approval process labels Apr 17, 2026
@exploreriii
exploreriii merged commit 15032e1 into hiero-ledger:main Apr 17, 2026
11 checks passed
@exploreriii

Copy link
Copy Markdown
Contributor

Thanks again @freya-docs

Abhijeet2409 pushed a commit to Abhijeet2409/hiero-sdk-python that referenced this pull request Apr 22, 2026
AntonioCeppellini pushed a commit to AntonioCeppellini/hiero-sdk-python that referenced this pull request Apr 22, 2026
parvninama pushed a commit to parvninama/hiero-sdk-python that referenced this pull request Apr 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Good First Issue Issues which are ideal for a first time or new project contributor. reviewer: write requires a review with write permissions status: update branch developer needs to click update branch step: merge ready PR is ready and waiting to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update Issue template with pre-commit documentation

3 participants