docs: gfi guidelines

[exploreriii]

Description:
Adds GFI guidelines building on @adityashirsatrao007 PR

Related issue(s):

Fixes #1065

Summary by CodeRabbit

• Documentation
  • Added comprehensive guidelines for Good First Issues to help contributors identify and work on suitable starting tasks.
  • Introduced documentation for the Good First Issue candidate label and its promotion workflow.
  • Enhanced issue templates with improved references and formatting for contributor guidelines.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

Walkthrough

The PR adds comprehensive guidelines documentation for Good First Issues and Good First Issue candidates, updates GitHub issue templates to reference these new guidelines, and records the additions in the changelog.

Changes

Cohort / File(s)	Change Summary
GitHub Issue Templates .github/ISSUE_TEMPLATE/01_good_first_issue.yml, .github/ISSUE_TEMPLATE/04_good_first_issue_candidate.yml	Updated issue template guidance references to point to the new maintainer guidelines documents with adjusted formatting and hyperlink syntax.
Maintainer Guidelines docs/maintainers/good_first_issues_guidelines.md, docs/maintainers/good_first_issue_candidate_guidelines.md	Added two new comprehensive documentation files defining Good First Issue scope (allowed and disallowed categories with examples), candidate promotion workflows, acceptance criteria, and best practices for maintainers and contributors.
Changelog CHANGELOG.md	Added entry under Unreleased/Added documenting the creation of Good First Issue and Good First Issue candidate guidelines linked to #1066.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Verification points: Review guidelines documentation for clarity, completeness, and alignment with intended scope; confirm template links are correct and formatted properly; validate changelog entry accuracy.

Possibly related issues

• [Good First Issue]: Create docs/maintainers/good_first_issue_candidate_guidelines.md #1066 — This PR directly implements the creation of both good_first_issue_candidate_guidelines.md and good_first_issues_guidelines.md documentation files as requested in the issue.

Possibly related PRs

• docs: add GFI-Guidelines Doc File #1128 — Related PR that also adds Good First Issue guidelines documentation and corresponding changelog entries with the same feature intent but different implementation scope.

Poem

🐰✨ Fresh guidelines bloom for contributors new,
A path well-lit through work they love to do,
Candidates rise to greatness, step by step,
With care and kindness, we all move ahead! 🌱

Pre-merge checks and finishing touches

✅ 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 'docs: gfi guidelines' is concise, clear, and accurately describes the main change: adding comprehensive Good First Issue guidelines documentation.
Linked Issues check	✅ Passed	The PR implements all major coding requirements from issue #1065: creates good_first_issues_guidelines.md with allowed/disallowed GFI categories, adds good_first_issue_candidate_guidelines.md, updates issue templates with proper links, and includes changelog entry.
Out of Scope Changes check	✅ Passed	All changes are directly related to the objectives: two new documentation files for GFI guidelines, updates to issue templates to reference the new guidelines, and a changelog entry documenting the additions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##             main    #1133   +/-   ##
=======================================
  Coverage   91.04%   91.04%           
=======================================
  Files         139      139           
  Lines        8409     8409           
=======================================
  Hits         7656     7656           
  Misses        753      753           

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

.github/ISSUE_TEMPLATE/04_good_first_issue_candidate.yml (1)

19-19: Consider making this reference a clickable markdown link for consistency.

Line 19 references the guidelines document as plain text, while lines 66-67 use a clickable markdown link format. For consistency and better user experience, consider updating line 19 to use the same markdown link format.

Apply this diff to make the reference a clickable link:

-        > docs/maintainers/good_first_issue_guidelines.md
+        > [`docs/maintainers/good_first_issues_guidelines.md`](docs/maintainers/good_first_issues_guidelines.md)

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e73693c and ab34757.

📒 Files selected for processing (5)

• .github/ISSUE_TEMPLATE/01_good_first_issue.yml (2 hunks)
• .github/ISSUE_TEMPLATE/04_good_first_issue_candidate.yml (1 hunks)
• CHANGELOG.md (1 hunks)
• docs/maintainers/good_first_issue_candidate_guidelines.md (1 hunks)
• docs/maintainers/good_first_issues_guidelines.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/maintainers/good_first_issue_candidate_guidelines.md

[style] ~64-~64: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...e behavior | | Test assertion missing | Need to confirm it extends existing tests only ...

(REP_NEED_TO_VB)

docs/maintainers/good_first_issues_guidelines.md

[style] ~181-~181: Consider a different adjective to strengthen your wording.
Context: ...ample files or workflows These require deeper understanding of intended usage pattern...

(DEEP_PROFOUND)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (7)

• GitHub Check: Codacy Static Code Analysis
• GitHub Check: build-and-test (3.12)
• GitHub Check: build-and-test (3.10)
• GitHub Check: build-and-test (3.13)
• GitHub Check: build-and-test (3.11)
• GitHub Check: run-examples
• GitHub Check: StepSecurity Harden-Runner

🔇 Additional comments (7)

.github/ISSUE_TEMPLATE/04_good_first_issue_candidate.yml (1)

66-67: LGTM!

The updated reference correctly points to the candidate-specific guidelines document with consistent two-line markdown link formatting.

.github/ISSUE_TEMPLATE/01_good_first_issue.yml (1)

58-59: LGTM!

The updated reference uses a consistent two-line markdown link format, making the guidelines document easily accessible to contributors.

docs/maintainers/good_first_issue_candidate_guidelines.md (3)

1-199: Excellent documentation structure and content!

This document is well-organized, comprehensive, and provides clear guidance on the candidate label workflow. The use of tables, checkboxes, and the ASCII workflow diagram makes it easy to understand. Great work!

---

47-47: File reference is valid.

Line 47's reference to ./good_first_issues_guidelines.md points to an existing file in the repository. The relative path is correct.

---

195-199: All referenced documentation files exist and relative paths are correct. No action needed.

docs/maintainers/good_first_issues_guidelines.md (2)

1-249: Outstanding documentation! Fully addresses all PR objectives.

This document is exceptionally well-crafted and comprehensively covers:

• ✅ Clear definition and purpose of GFIs
• ✅ Detailed allowed categories with specific examples
• ✅ Explicit disallowed categories
• ✅ Maintainer guidance on when (not) to label GFIs
• ✅ Links to relevant resources

The structure, formatting, and examples make this highly accessible for both maintainers and contributors. Excellent work!

---

245-249: All referenced documentation files are present and valid.

The files referenced in lines 245-249 (CONTRIBUTING.md, docs/sdk_developers/signing.md, docs/sdk_developers/changelog_entry.md, and docs/discord.md) all exist in the repository with correct relative paths.

[manishdait]

LGTM 👍

[exploreriii]

thanks!!