Skip to content

Added repo instructions for copilot#274

Open
GrimA9e wants to merge 1 commit into
vividus-framework:mainfrom
GrimA9e:copilot_instructions
Open

Added repo instructions for copilot#274
GrimA9e wants to merge 1 commit into
vividus-framework:mainfrom
GrimA9e:copilot_instructions

Conversation

@GrimA9e
Copy link
Copy Markdown
Contributor

@GrimA9e GrimA9e commented Apr 28, 2026

Summary by CodeRabbit

  • Documentation
    • Added contributor guidelines for the test automation project covering project layout and how tests/resources are organized.
    • Documented standard build and validation commands, code formatting expectations, and recommended bootstrap steps.
    • Described suite-specific discovery and configuration patterns, test run/debug behaviors, test reporting location, and CI validation/workflow triggers.

@GrimA9e GrimA9e requested a review from a team as a code owner April 28, 2026 12:53
@GrimA9e GrimA9e requested review from uarlouski, valfirst and vkepin and removed request for a team April 28, 2026 12:53
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Warning

Rate limit exceeded

@GrimA9e has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 22 minutes and 42 seconds before requesting another review.

You’ve run out of usage credits. Purchase more in the billing tab.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: 6110455a-c979-4731-b46f-c32a92ba6823

📥 Commits

Reviewing files that changed from the base of the PR and between 7a35946 and b02df42.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md
📝 Walkthrough

Walkthrough

Adds a new contributor-facing Copilot instructions document .github/copilot-instructions.md that describes project layout, where test logic lives, Gradle bootstrap/build/validation commands, Spotless formatting rules, suite discovery and execution details, and CI/PR validation behavior.

Changes

Cohort / File(s) Summary
Documentation
/.github/copilot-instructions.md
New contributor instructions covering repository layout, that test logic resides under src/main/resources/, Gradle bootstrap and standard commands (./gradlew build, ./gradlew spotlessApply), Spotless formatting expectations, suite discovery via configuration.properties and per-suite suite.properties, typical runStories/debugStories invocations, known-issues handling, and CI/PR workflow triggers and validation.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 5
✅ 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 'Added repo instructions for copilot' directly and clearly describes the main change: introducing a new Copilot instructions document for the repository.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 29, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

Copy link
Copy Markdown

@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

🤖 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 24-35: The fenced code block showing the directory listing (the
triple-backtick block that begins with "src/main/resources/") lacks a language
specifier; update that block to include a language identifier such as "text"
(e.g., change ``` to ```text) so the block renders and lints correctly in
.github/copilot-instructions.md.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: ASSERTIVE

Plan: Pro

Run ID: dea64a93-dcab-4782-aeb4-c7275d2f79c9

📥 Commits

Reviewing files that changed from the base of the PR and between d97ac03 and 1704849.

📒 Files selected for processing (1)
  • .github/copilot-instructions.md

Comment thread .github/copilot-instructions.md Outdated
@GrimA9e GrimA9e force-pushed the copilot_instructions branch from 1704849 to 7a35946 Compare April 29, 2026 11:01
Comment thread .github/copilot-instructions.md Outdated
./gradlew spotlessApply # Auto-fix formatting violations
```

Spotless enforces on `*.story`, `*.steps`, `*.table`, `*.properties`, `*.json`, `*.md`, and more: no trailing whitespace, no tabs (use spaces), file must end with a newline.
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.

why is it needed?

Comment thread .github/copilot-instructions.md Outdated
./gradlew runStories -Pvividus.configuration-set.active=web-app # Web UI (requires Chrome)
./gradlew runStories -Pvividus.configuration-set.active=ios-app # iOS (macOS + Appium + simulator)
./gradlew runStories -Pvividus.configuration-set.active=android-app # Android (macOS + Appium + emulator)
./gradlew runStories -Pvividus.configuration-set.active=electron # Electron (requires VS Code)
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.

Suggested change
./gradlew runStories -Pvividus.configuration-set.active=electron # Electron (requires VS Code)
./gradlew runStories -Pvividus.configuration-set.active=electron # Electron (VS Code is a system under test)

Comment thread .github/copilot-instructions.md Outdated
./gradlew runStories -Pvividus.configuration-set.active=electron # Electron (requires VS Code)
```

`debugStories` skips build checks (used in some CI pipelines). Reports go to `output/reports/allure/`.
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.

Suggested change
`debugStories` skips build checks (used in some CI pipelines). Reports go to `output/reports/allure/`.
`debugStories` - task that skips build checks.
Reports go to `output/reports/allure/`.

Comment thread .github/copilot-instructions.md Outdated
Comment on lines +55 to +57
## CI on Pull Requests

`gradle.yml` runs `./gradlew build` on every PR to `main` and fails on formatting violations or malformed properties. Suite-specific workflows trigger when their paths change: `test-run.yml` (rest-api/web-app), `mobile-test-run.yml` (mobile), `electron-tests.yml` (electron).
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.

why is this section needed?

@GrimA9e GrimA9e force-pushed the copilot_instructions branch from d1eaae8 to 3a64f2e Compare May 15, 2026 09:20
@GrimA9e GrimA9e force-pushed the copilot_instructions branch from 3a64f2e to b02df42 Compare May 15, 2026 09:21
@GrimA9e GrimA9e requested a review from valfirst May 15, 2026 09:21
@valfirst
Copy link
Copy Markdown
Contributor

Looks ok, but this PR depends on PR with configuration set changes

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.

2 participants