CLID-634: Update CONTRIBUTING.md#1450
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@dorzel: This pull request references CLID-634 which is a valid jira issue. Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the story to target the "5.0.0" version, but no target version was set. DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Repository: openshift/coderabbit/.coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (1)
Walkthrough
ChangesContribution guide rewrite
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 🚥 Pre-merge checks | ✅ 15✅ Passed checks (15 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: dorzel The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
14-14: 📐 Maintainability & Code Quality | 🔵 Trivial | ⚡ Quick winMarkdown heading style inconsistency.
The guide uses ATX-style headers (
#syntax) but the project's markdownlint configuration expects setext-style headers (underline with===or---). For consistency, convert these headings to setext style to match the linter's expectations.💫 Proposed fix for heading style conversion
-## Development +Development +=========== Active development happens in the root directory (v2). Code under `v1/` is deprecated. Please do not submit changes there. Development workflow: -## Reporting Bugs +Reporting Bugs +============== Please submit bug reports as GitHub Issues using our [template](.github/ISSUE_TEMPLATE.md). Include: -## Requesting Enhancements +Requesting Enhancements +====================== 1. A concise title and description of the modification -## Pull Requests +Pull Requests +============= When submitting pull requests, please ensure the following: -## Testing +Testing +======= See our [testing strategy](docs/testing/README.md) for guidelines on testing levels and principles. -## Docs Contributions +Docs Contributions +==================Also applies to: 31-31, 39-39, 47-47, 55-55, 59-59
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@CONTRIBUTING.md` at line 14, The markdown headings in CONTRIBUTING.md use ATX-style headers (# and ## syntax) but the project's markdownlint configuration requires setext-style headers with underlines. Convert all ATX-style headers to setext-style by replacing the hash symbols with underlines using equals signs (===) for level-one headings and hyphens (---) for level-two headings. This applies to the "Development" heading at line 14 and the additional headings at lines 31, 39, 47, 55, and 59 mentioned in the comment.Source: Linters/SAST tools
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 14: The markdown headings in CONTRIBUTING.md use ATX-style headers (# and
## syntax) but the project's markdownlint configuration requires setext-style
headers with underlines. Convert all ATX-style headers to setext-style by
replacing the hash symbols with underlines using equals signs (===) for
level-one headings and hyphens (---) for level-two headings. This applies to the
"Development" heading at line 14 and the additional headings at lines 31, 39,
47, 55, and 59 mentioned in the comment.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository: openshift/coderabbit/.coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 1f60b27a-7137-452a-a168-a1c05ef6b86a
📒 Files selected for processing (1)
CONTRIBUTING.md
|
@dorzel: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
3 participants
Description
Update CONTRIBUTING.md. Removed some references to docs that only existed in v1. Open item as to whether we want to include those or not again. I think pointing to an ARCHITECTURE.md will cover some of that ground.
Github / Jira issue: https://redhat.atlassian.net/browse/CLID-634
Type of change
Please delete options that are not relevant.
How Has This Been Tested?
Expected Outcome
Summary by CodeRabbit
make-based workflow for building and running checks, including a recommendation to runmake sanitybefore committing; streamlined bug/enhancement request checklists.