Skip to content

docs: Clarify AI usage in templates - #1930

Merged
exploreriii merged 4 commits into
hiero-ledger:mainfrom
freya-docs:clarify-ai-usage-in-templates
Mar 10, 2026
Merged

docs: Clarify AI usage in templates#1930
exploreriii merged 4 commits into
hiero-ledger:mainfrom
freya-docs:clarify-ai-usage-in-templates

Conversation

@freya-docs

Copy link
Copy Markdown
Contributor

Description:

This PR adds clarification about AI usage to two template files.

Related issue(s):

Fixes #1923

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
@freya-docs
freya-docs requested review from a team as code owners March 7, 2026 19:17
@coderabbitai

coderabbitai Bot commented Mar 7, 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: ff7a7afe-b477-4672-8bf3-2c2a99159451

📥 Commits

Reviewing files that changed from the base of the PR and between b58d7a6 and bfe0c49.

📒 Files selected for processing (1)
  • CHANGELOG.md

Walkthrough

Updated two Good First Issue templates to change the audience wording to "new human contributors" and replaced the previous multi-line AI guidance with a single policy: humans may use AI tools but AI bot-authored PRs are not accepted. Added a CHANGELOG entry noting the clarification.

Changes

Cohort / File(s) Summary
Good First Issue templates
\.github/ISSUE_TEMPLATE/01_good_first_issue_candidate.yml, \.github/ISSUE_TEMPLATE/02_good_first_issue.yml
Reworded intro from "new contributors" → "new human contributors". Removed the multi-line paragraph listing example AI-assisted tasks and replaced AI guidance with a single policy line: "Humans are welcome to use AI tools while working on this issue but we do not accept AI bot-authored PRs."
Changelog
CHANGELOG.md
Added Unreleased docs entry summarizing the clarification of AI usage in Good First Issue templates (#[1923]).

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: clarifying AI usage in template files, which matches the primary objective of the PR.
Description check ✅ Passed The description accurately states that the PR adds clarification about AI usage to two template files and references the linked issue #1923.
Linked Issues check ✅ Passed The code changes successfully implement all required modifications: adding 'human' to intro text, replacing AI policy language, and removing the referenced paragraph from both templates [#1923].
Out of Scope Changes check ✅ Passed All changes are scoped to the two template files and changelog entry as specified in #1923; no out-of-scope modifications are 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: #1923

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.


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.

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

Thanks @freya-docs we require a changelog entry here at the python sdk 👍

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
@freya-docs freya-docs changed the title Clarify AI usage in templates docs: Clarify AI usage in templates Mar 7, 2026
exploreriii
exploreriii previously approved these changes Mar 7, 2026
@codecov

codecov Bot commented Mar 7, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1930   +/-   ##
=======================================
  Coverage   93.53%   93.53%           
=======================================
  Files         141      141           
  Lines        9146     9146           
=======================================
  Hits         8555     8555           
  Misses        591      591           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@exploreriii

Copy link
Copy Markdown
Contributor

Hi @freya-docs would you mind rebasing please? We think the checks might now pass.
You have a merge conflict - please accept both changes

Signed-off-by: freya-docs <freya.docs.pp@gmail.com>
@freya-docs

Copy link
Copy Markdown
Contributor Author

@exploreriii I've done it, please let me know if it is ok now.

@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 so much! For this needed update

@exploreriii
exploreriii merged commit 51218c0 into hiero-ledger:main Mar 10, 2026
15 checks passed
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.

[Good First Issue]: Edit templates to be human-only

3 participants