Skip to content

docs: update "How It Works" to reflect default-on assignee behavior#83

Merged
SebastianSzt merged 2 commits into
feature/default-configfrom
copilot/sub-pr-82
Mar 6, 2026
Merged

docs: update "How It Works" to reflect default-on assignee behavior#83
SebastianSzt merged 2 commits into
feature/default-configfrom
copilot/sub-pr-82

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 6, 2026

Pull Request

Description

The "How It Works" section implied users must explicitly enable addPullRequestAuthorAsAssignee, conflicting with the default value of true introduced in #82.

  • README.md (line 28): Reworded step 2 from opt-in framing (If ... true is set) to default-on framing (Unless ... false is configured)

Type of change

  • Documentation update

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have documented my changes with clear TSDoc comments
  • My commit messages follow Conventional Commits / Semantic Release
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing tests pass locally with my changes
  • No sensitive information (e.g., secrets, passwords) is included in the code

🔒 GitHub Advanced Security automatically protects Copilot coding agent pull requests. You can protect all pull requests by enabling Advanced Security for your repositories. Learn more about Advanced Security.

…vior

Co-authored-by: SebastianSzt <94396040+SebastianSzt@users.noreply.github.com>
Copilot AI changed the title [WIP] WIP Address feedback on default config feature changes docs: update "How It Works" to reflect default-on assignee behavior Mar 6, 2026
@SebastianSzt SebastianSzt marked this pull request as ready for review March 6, 2026 20:24
@SebastianSzt SebastianSzt merged commit 196f16a into feature/default-config Mar 6, 2026
2 checks passed
@SebastianSzt SebastianSzt deleted the copilot/sub-pr-82 branch March 6, 2026 20:25
@github-actions
Copy link
Copy Markdown

github-actions Bot commented Mar 6, 2026

🎉 This PR is included in version 2.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants