text change in contributing.md#1490
Conversation
|
Important Review skippedAuto incremental reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the WalkthroughThe contributing guidelines were updated to clarify the process for duplicating a CommCare Android change to Formplayer. The instructions now specify the PR approval process and revise the steps for creating and handling the duplicate PR, particularly regarding branch management and workflow triggers. Changes
Poem
✨ Finishing Touches🧪 Generate 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/contributing.md (2)
24-24: Tighten wording and fix awkward phrasingThe instruction is clear but a bit wordy and contains a minor grammatical hiccup (“Get it approved and not merge it”). Consider streamlining for readability:
-1. If you are working on a CommCare Android change, you have to start by checking out `your_feature_branch` from `master` as the base branch. Make changes on `your_feature_branch` and create your original PR against `master` branch. Get it approved and not merge it. +1. If you are working on a CommCare Android change, start by checking out `your_feature_branch` from `master` as the base branch. After making your changes, open a PR against the `master` branch, get it approved, but do not merge it.
26-26: Add missing comma and improve clarityA comma after the introductory phrase (“For this”) improves flow, and the paragraph can be simplified. “Github” should also be capitalised.
-2. Now you will need to duplicate this PR by making another PR against `formplayer`. For this create the comment `duplicate this PR <starting-commit-id> <ending-commit-id>` of the `your_feature_branch`. The `ending-commit-id` should be the last non-merge commit in the PR. This should result in a Github Actions workflow duplicating your PR against `formplayer`. Go to the duplicate PR, close and re-open it to run the Github checks against it. +2. Next, create a duplicate PR against the `formplayer` branch. For this, add the comment `duplicate this PR <starting-commit-id> <ending-commit-id>` on the original `your_feature_branch` PR. The `ending-commit-id` should be the last non-merge commit in that PR. This comment triggers a GitHub Actions workflow that opens the duplicate PR against `formplayer`. After the duplicate PR appears, close and reopen it to kick off the GitHub checks.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/contributing.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/contributing.md
[typographical] ~26-~26: Use a comma after an introductory phrase.
Context: ...making another PR against formplayer. For this create the comment `duplicate this PR <...
(COMMA_INTRODUCTORY_WORDS_PHRASES)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: task-list-completed
- GitHub Check: task-list-completed
| ##### Duplicating A CommCare Android change to Formplayer | ||
|
|
||
| 1. If you are working on a CommCare Android change, you will want to start by checking out `your_feature_branch` from `master` as the base branch. Make changes on `your_feature_branch` and create your original PR against `master` branch. | ||
| 1. If you are working on a CommCare Android change, you have to start by checking out `your_feature_branch` from `master` as the base branch. Make changes on `your_feature_branch` and create your original PR against `master` branch. Get it approved and not merge it. |
There was a problem hiding this comment.
not merge it -> do not merge it
There was a problem hiding this comment.
We should add that it's fine to merge after the duplicate PR has been created somewhere below.
2 participants
Product Description
Change in the Contributing file with the updated text to create duplicate PR
Technical Summary
Safety Assurance
Safety story
Automated test coverage
QA Plan
Special deploy instructions
Rollback instructions
Review
Duplicate PR
Automatically duplicate this PR as defined in contributing.md.
Summary by CodeRabbit