docs: add GFI-Guidelines Doc File

[aceppaluni]

Description:

This PR aims to add in the Good-First-Issue documentation for the scope of what good-first-issues should contain.

Related issue(s): N/A

Fixes #
No issue number, one can be created and applied.

Notes for reviewer:

Explains what the purpose and scope should be when creating good-first-issues.

Checklist

• Documented (Code comments, README, etc.)
• Tested (unit, integration, etc.)

Summary by CodeRabbit

• Documentation
  • Added Good First Issue guidelines documentation for SDK maintainers, including qualification criteria, practical examples, and SDK-specific customization notes.

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

[coderabbitai]

Walkthrough

A new comprehensive Good First Issue (GFI) guidelines document has been added to the SDK repository, accompanied by a changelog entry. The guidelines define GFI criteria, provide concrete examples across code changes, refactoring, documentation, and testing, and include SDK-specific customization notes and maintainer responsibilities.

Changes

Cohort / File(s)	Summary
Documentation CHANGELOG.md	Added entry documenting new SDK-level Good First Issue guidelines for maintainers
Good First Issue Guidelines docs/GFI/GFI-Guidelines.md	New comprehensive guide defining GFI criteria (narrow scope, low risk, easy testing), providing concrete examples across code changes, refactoring, documentation, and tests, and clarifying what does not qualify as a GFI

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

• Review the GFI guidelines document for clarity, completeness, and alignment with SDK practices
• Verify changelog entry accuracy and formatting consistency

Possibly related issues

• [Good First Issue]: Extend docs/maintainers/good_first_issues_guidelines.md #1065: PR addresses the objective of establishing comprehensive Good First Issue guidelines tailored for SDK maintainers to standardize contributor onboarding

Poem

🐰 Guidelines bloom like garden rows,
Where contributors and good-first-issues grow,
Narrow scope and testing clear,
Low-risk pathways, drawing near,
Maintainers' compass, shining bright! 🌟

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.
Title check	✅ Passed	The title clearly and concisely describes the main change: adding a GFI (Good First Issue) Guidelines documentation file to the docs directory.
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

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7d1aa58 and 2f14020.

📒 Files selected for processing (2)

• CHANGELOG.md (1 hunks)
• docs/GFI/GFI-Guidelines.md (1 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/GFI/GFI-Guidelines.md

[uncategorized] ~20-~20: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...st Issue should be: - Narrow in scope - Low risk - Easy to test or validate - Achievable...

(EN_COMPOUND_ADJECTIVE_INTERNAL)

---

[style] ~22-~22: Consider a different adjective to strengthen your wording.
Context: ...o test or validate - Achievable without deep domain knowledge of the SDK Below are ...

(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). (1)

• GitHub Check: Codacy Static Code Analysis

🔇 Additional comments (2)

CHANGELOG.md (1)

12-12: LGTM!

The changelog entry clearly and concisely documents the new GFI guidelines addition. The phrasing appropriately specifies SDK-level scope and audience.

docs/GFI/GFI-Guidelines.md (1)

1-138: Excellent comprehensive GFI guidance!

This document is well-structured and immediately useful. The clear criteria, concrete examples across code changes, refactoring, documentation, and tests, combined with explicit SDK-specific and maintainer guidance, sets realistic expectations for both contributors and maintainers. The distinction between what qualifies as a GFI and what doesn't is particularly helpful for reducing ambiguity.

---

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.}

[github-actions]

Hi, this is WorkflowBot.
Your pull request cannot be merged as it is not passing all our workflow checks.
Please click on each check to review the logs and resolve issues so all checks pass.
To help you:

• DCO signing guide
• Changelog guide
• Merge conflicts guide
• Rebase guide
• Testing guide
• Discord
• Community Calls
  Thank you for contributing!
  From the Hiero Python SDK Team

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

@@           Coverage Diff           @@
##             main    #1128   +/-   ##
=======================================
  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.

[exploreriii]

LGTM - works well
We need these docs urgently, we can improve them over time