-
Notifications
You must be signed in to change notification settings - Fork 0
Standardize branding to lowercase **randomforge** across docs and #2
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
vignettes - Updated all references from RandomForge to **randomforge** - Improved consistency in documentation and markdown files - Adjusted vignette headings to use appropriate markdown levels - Simplified example code for block randomization method usage - Enhanced clarity in contribution and getting started guides - Fixed minor formatting issues in vignettes
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR standardizes the branding from "RandomForge" to lowercase "randomforge" across documentation, vignettes, and code files. The changes improve consistency in how the project name is presented throughout the codebase, updates vignette headings to use appropriate markdown levels, and simplifies example code.
Key Changes:
- Standardized all "RandomForge" references to lowercase "randomforge" with bold formatting
- Updated vignette heading levels from
#(H1) to##(H2) for proper document structure - Simplified block randomization example code by removing optional parameters with defaults
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| vignettes/randomforge_getting_started.Rmd | Updated heading levels from H1 to H2 for better vignette structure |
| vignettes/randomforge_contribution.Rmd | Standardized branding to lowercase, updated heading structure, simplified code examples with suppressMessages() |
| README.md | Changed "RandomForge" references to lowercase "randomforge" for consistency |
| R/pkgname.R | Updated package documentation to use lowercase "randomforge" branding |
| NEWS.md | Standardized ecosystem reference to use bold "randomforge" formatting |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review for a chance to win a $100 gift card. Take the survey.
| #' covariate-adaptive, and response-adaptive techniques while | ||
| #' enabling reproducibility, auditability, and methodological clarity. | ||
| #' Built as part of the open RandomForge initiative ("Innovating the | ||
| #' Built as part of the open *randomforge* initiative ("Innovating the |
Copilot
AI
Nov 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Inconsistent branding formatting. The branding is formatted as italics *randomforge* here, but elsewhere in this PR it's formatted as bold **randomforge** (e.g., README.md line 12, NEWS.md line 6).
For consistency, use the same formatting convention throughout. Recommendation: Use bold **randomforge** when referring to the initiative/brand, and code formatting `randomforge` when referring to the R package.
| #' Built as part of the open *randomforge* initiative ("Innovating the | |
| #' Built as part of the open **randomforge** initiative ("Innovating the |
|
|
||
|
|
||
| # 4. Option B: Contribute via Fork (recommended for most users) | ||
| ### Option B: Contribute via Fork (recommended for most users) |
Copilot
AI
Nov 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The heading structure is inconsistent with the introduction (lines 34-38). The introduction mentions three main topics:
- Install and try the package
- Contribute to the project
- Use GitHub effectively
However, "Option A" and "Option B" are now level-3 headings (###) under "## How to contribute to randomforge", which makes them appear as subsections of topic 2. Since Option B explicitly covers "Use GitHub effectively" (topic 3), these should either be:
- Level-2 headings (##) to match the structure suggested in the introduction, or
- The introduction should be updated to reflect that topics 2 and 3 are combined under "How to contribute"
Consider changing these to ## Option A:... and ## Option B:... to maintain consistency with the introductory list.
| ### Option B: Contribute via Fork (recommended for most users) | |
| ## Option B: Contribute via Fork (recommended for most users) |
| ## Thank you | ||
|
|
||
| We appreciate your interest in contributing to the RandomForge project. | ||
| We appreciate your interest in contributing to the *randomforge* project. |
Copilot
AI
Nov 25, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[nitpick] Inconsistent branding formatting. Throughout the PR, "randomforge" is formatted in different ways:
- As italics
*randomforge*(line 36 in R/pkgname.R, line 218 here) - As bold
**randomforge**(lines 3, 12, 26, 65 in README.md, line 6 in NEWS.md) - As plain code
`randomforge`in most other places
For consistency across the codebase, establish a single formatting convention. Recommendation: Use bold **randomforge** when referring to the initiative/brand, and code formatting `randomforge` when referring to the R package.
| We appreciate your interest in contributing to the *randomforge* project. | |
| We appreciate your interest in contributing to the **randomforge** project. |
vignettes