Update CONTRIBUTING.md with new instructions#1741
Update CONTRIBUTING.md with new instructions#1741rita-gorokhod merged 13 commits intoopenops-cloud:mainfrom
Conversation
|
Important Review skippedAuto 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 ✨ 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 |
Greptile OverviewGreptile SummaryThis PR improves the CONTRIBUTING.md documentation by restructuring content, adding helpful links to GitHub issues and the contributing docs site, and reducing repetition. The changes make it easier for contributors to navigate the guide and take action.
Confidence Score: 4/5
Important Files ChangedFile Analysis
Sequence DiagramsequenceDiagram
participant Contributor
participant CONTRIBUTING.md
participant GitHub Issues
participant Docs Site
participant Slack Community
Contributor->>CONTRIBUTING.md: Read contributing guide
CONTRIBUTING.md->>Contributor: Shows navigation links
alt Reporting a Bug
Contributor->>GitHub Issues: Search existing issues
GitHub Issues->>Contributor: Returns search results
alt Bug not found
Contributor->>GitHub Issues: Open new issue (bug.md template)
Contributor->>CONTRIBUTING.md: Reference PR section if fixing
end
end
alt Suggesting a Feature
Contributor->>GitHub Issues: Search existing issues
GitHub Issues->>Contributor: Returns search results
alt Feature not suggested
Contributor->>GitHub Issues: Propose feature (feature-request.md)
else Feature exists
Contributor->>GitHub Issues: React with 👍
end
Contributor->>Slack Community: Discuss ideas (optional)
end
alt Creating a Pull Request
Contributor->>CONTRIBUTING.md: Read PR guidelines
CONTRIBUTING.md->>Docs Site: Link to dev environment setup
Docs Site->>Contributor: Setup instructions
CONTRIBUTING.md->>Docs Site: Link to integration guide
Docs Site->>Contributor: Development guidance
Contributor->>GitHub Issues: Discuss in relevant issue
Contributor->>Slack Community: Get feedback (optional)
Contributor->>GitHub Issues: Submit PR
end
|
There was a problem hiding this comment.
Additional Comments (2)
-
CONTRIBUTING.md, line 13-15 (link)syntax: Internal anchor links include emoji characters, but GitHub ignores emojis when creating anchor IDs. The links won't work correctly.
-
CONTRIBUTING.md, line 35 (link)syntax: Anchor link includes emoji character but should match GitHub's auto-generated anchor ID (without emoji).
1 file reviewed, 2 comments
There was a problem hiding this comment.
Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.
|



Based on DOC-142, this PR updates CONTRIBUTING.md to:
Fixes DOC-142