Skip to content

chore(.github): apply Spotless formatting fixes to copilot-instructions.md#20

Merged
yacosta738 merged 2 commits into
mainfrom
refactor/ruleset
Feb 17, 2026
Merged

chore(.github): apply Spotless formatting fixes to copilot-instructions.md#20
yacosta738 merged 2 commits into
mainfrom
refactor/ruleset

Conversation

@yacosta738
Copy link
Copy Markdown
Contributor

@yacosta738 yacosta738 commented Feb 17, 2026

This pull request introduces a new set of agent instructions for the repository, focusing on security-first and performance-second principles, and provides comprehensive guidelines for development, testing, and project structure. Additionally, it makes minor formatting adjustments to the branch protection ruleset configuration.

Documentation and Guidelines:

  • Added a new .github/copilot-instructions.md file that details core development principles (security and performance), quick commands for building and testing, code style conventions, Gradle best practices, project structure, available skills, and testing patterns.

Configuration Formatting:

  • Reformatted the include array for ref_name and the allowed_merge_methods array in .github/rulesets/main-protection.json to use single-line array formatting for improved readability and consistency. [1] [2]

Summary by CodeRabbit

  • Documentation
    • Added comprehensive project guidelines and development documentation for contributors.

@github-actions
Copy link
Copy Markdown
Contributor

Thank you for contributing to this project with this PR, welcome to the community and the amazing world of open source!

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Feb 17, 2026

📝 Walkthrough

Walkthrough

A new Markdown document added to .github/ containing comprehensive guidelines for a Gradle-based Kotlin multi-module project. It covers security and performance principles, build commands, code style, Kotlin patterns, naming conventions, error handling, Gradle best practices, dependency management, and project structure documentation.

Changes

Cohort / File(s) Summary
Copilot Guidelines
.github/copilot-instructions.md
New configuration file documenting agent principles, build/test commands, Kotlin patterns (data classes, value classes, sealed results), error handling (recoverable and domain-specific exceptions), Gradle best practices (task registration, caching), version catalog usage, project structure, and licensing information.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

🚥 Pre-merge checks | ✅ 1 | ❌ 2

❌ Failed checks (2 warnings)

Check name Status Explanation Resolution
Title check ⚠️ Warning The title references 'apply Spotless formatting fixes to copilot-instructions.md', but the raw summary shows the file was newly added (+194/-0) with no existing file, making 'formatting fixes' misleading. Update the title to reflect the actual change: 'chore(.github): add copilot-instructions.md with development guidelines' to accurately describe adding a new file, not formatting an existing one.
Description check ⚠️ Warning The description mentions adding copilot-instructions.md and reformatting main-protection.json, but the raw summary shows only copilot-instructions.md was modified (+194/-0), with no mention of changes to main-protection.json. Clarify which files were actually changed in this PR. If main-protection.json was not modified, remove that section. If it was, ensure the raw summary reflects all changes.
✅ Passed checks (1 passed)
Check name Status Explanation
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.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch refactor/ruleset

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 17, 2026

✅ Contributor Report

User: @yacosta738
Status: Passed (12/13 metrics passed)

Metric Description Value Threshold Status
PR Merge Rate PRs merged vs closed 89% >= 30%
Repo Quality Repos with ≥100 stars 0 >= 0
Positive Reactions Positive reactions received 9 >= 1
Negative Reactions Negative reactions received 0 <= 5
Account Age GitHub account age 3035 days >= 30 days
Activity Consistency Regular activity over time 108% >= 0%
Issue Engagement Issues with community engagement 0 >= 0
Code Reviews Code reviews given to others 361 >= 0
Merger Diversity Unique maintainers who merged PRs 3 >= 0
Repo History Merge Rate Merge rate in this repo 93% >= 0%
Repo History Min PRs Previous PRs in this repo 17 >= 0
Profile Completeness Profile richness (bio, followers) 90 >= 0
Suspicious Patterns Spam-like activity detection 1 N/A

Contributor Report evaluates based on public GitHub activity. Analysis period: 2025-02-17 to 2026-02-17

Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (2)
.github/copilot-instructions.md (2)

139-139: Add language specification to code block.

The fenced code block should specify a language for better markdown compliance and consistent rendering. Consider using text or plaintext.

♻️ Proposed fix
-```
+```text
 ├── apps/
 │   ├── composeApp/         # Shared Kotlin Multiplatform Compose UI module
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/copilot-instructions.md at line 139, The fenced code block currently
uses plain triple backticks without a language hint; update the opening fence
from ``` to ```text (or ```plaintext) so the block is language-specified (e.g.,
change ``` to ```text before the tree snippet lines starting with "├── apps/").
Ensure the closing fence remains ``` and no other content is changed.

21-25: Remove extra spaces after blockquote symbols.

Lines 21-25 have multiple spaces after the > symbol, which violates markdown standards. Use a single space for consistency.

♻️ Proposed fix for blockquote spacing
-> 2. **Extreme Performance Second** - Optimize for efficiency after security
->    - Think about algorithmic complexity (O(n) vs O(n²))
->    - Avoid unnecessary allocations
->    - Use lazy initialization when appropriate
->    - Profile before optimizing - measure don't guess
->    - Consider memory footprint and startup time
+> 2. **Extreme Performance Second** - Optimize for efficiency after security
+>    - Think about algorithmic complexity (O(n) vs O(n²))
+>    - Avoid unnecessary allocations
+>    - Use lazy initialization when appropriate
+>    - Profile before optimizing - measure don't guess
+>    - Consider memory footprint and startup time
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/copilot-instructions.md around lines 21 - 25, The blockquote lines
starting with ">" shown in the diff have multiple spaces after the ">"—replace
the extra spaces with a single space for each blockquote (e.g., change ">    -
Think..." to "> - Think...") to conform to markdown style; update all affected
blockquote items in .github/copilot-instructions.md so every ">" is followed by
exactly one space and ensure consistency across similar list items.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In @.github/copilot-instructions.md:
- Around line 15-18: The four security principle lines are indented but missing
the blockquote prefix, breaking the Markdown blockquote; update those lines (the
bullets "Use parameterized queries, never string concatenation for SQL",
"Validate and sanitize all data", "Follow principle of least privilege", and
"Keep dependencies updated to patch security vulnerabilities") to include the
leading ">" so they belong to the surrounding blockquote (or alternatively
un-indent them to move them outside the blockquote) to restore consistent
formatting.

---

Nitpick comments:
In @.github/copilot-instructions.md:
- Line 139: The fenced code block currently uses plain triple backticks without
a language hint; update the opening fence from ``` to ```text (or ```plaintext)
so the block is language-specified (e.g., change ``` to ```text before the tree
snippet lines starting with "├── apps/"). Ensure the closing fence remains ```
and no other content is changed.
- Around line 21-25: The blockquote lines starting with ">" shown in the diff
have multiple spaces after the ">"—replace the extra spaces with a single space
for each blockquote (e.g., change ">    - Think..." to "> - Think...") to
conform to markdown style; update all affected blockquote items in
.github/copilot-instructions.md so every ">" is followed by exactly one space
and ensure consistency across similar list items.

Comment on lines +15 to +18
- Use parameterized queries, never string concatenation for SQL
- Validate and sanitize all data
- Follow principle of least privilege
- Keep dependencies updated to patch security vulnerabilities
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.

⚠️ Potential issue | 🟡 Minor

Fix blockquote formatting inconsistency.

These security principle lines are indented but lack the > blockquote prefix, breaking the blockquote structure. They should either be part of the blockquote (with > prefix) or unindented to be outside it.

📝 Proposed fix to include lines in blockquote
->    - Use parameterized queries, never string concatenation for SQL
->    - Validate and sanitize all data
->    - Follow principle of least privilege
->    - Keep dependencies updated to patch security vulnerabilities
+>    - Use parameterized queries, never string concatenation for SQL
+>    - Validate and sanitize all data
+>    - Follow principle of least privilege
+>    - Keep dependencies updated to patch security vulnerabilities
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/copilot-instructions.md around lines 15 - 18, The four security
principle lines are indented but missing the blockquote prefix, breaking the
Markdown blockquote; update those lines (the bullets "Use parameterized queries,
never string concatenation for SQL", "Validate and sanitize all data", "Follow
principle of least privilege", and "Keep dependencies updated to patch security
vulnerabilities") to include the leading ">" so they belong to the surrounding
blockquote (or alternatively un-indent them to move them outside the blockquote)
to restore consistent formatting.

@yacosta738 yacosta738 merged commit 1cce869 into main Feb 17, 2026
11 of 13 checks passed
@yacosta738 yacosta738 deleted the refactor/ruleset branch February 17, 2026 16:20
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.

1 participant