Skip to content

Update CONTRIBUTING.md with new instructions#1741

Merged
rita-gorokhod merged 13 commits intoopenops-cloud:mainfrom
gorohoroh:contribution-guidelines
Dec 10, 2025
Merged

Update CONTRIBUTING.md with new instructions#1741
rita-gorokhod merged 13 commits intoopenops-cloud:mainfrom
gorohoroh:contribution-guidelines

Conversation

@gorohoroh
Copy link
Copy Markdown
Collaborator

@gorohoroh gorohoroh commented Dec 5, 2025

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

Fixes DOC-142

  1. Improve structure
  2. Introduce links to the contributing docs where relevant
  3. Introduce other relevant links, mostly to GitHub Issues in sections on bug reporting and feature suggestions
  4. Reduce repetition

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Dec 5, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented Dec 5, 2025

Greptile Overview

Greptile Summary

This 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.

  • Fixed typo: "Contribuitng" → "Contributing" in image alt text
  • Added internal navigation links to major sections (bug reporting, feature suggestions, pull requests)
  • Integrated direct links to GitHub issue templates and the issues page
  • Added links to contributing documentation at docs.openops.com
  • Improved section organization and flow
  • Removed redundant "Code Style Guidelines" section (content now integrated into PR section)
  • Moved license notice into the PR section for better context
  • Issue found: Internal anchor links include emoji characters (e.g., #-reporting-bugs) but GitHub strips emojis from anchor IDs, so these links won't work

Confidence Score: 4/5

  • This PR is safe to merge once anchor link syntax is corrected
  • The changes are purely documentation updates that improve structure and usability. The only issue is broken internal anchor links due to emoji characters in the URLs, which is a quick fix
  • CONTRIBUTING.md requires attention to fix internal anchor link syntax

Important Files Changed

File Analysis

Filename Score Overview
CONTRIBUTING.md 4/5 Improved structure and added helpful links. Fixed typo in image alt text. Internal anchor links need emoji removal to work correctly.

Sequence Diagram

sequenceDiagram
    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
Loading

Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Additional Comments (2)

  1. 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.

  2. 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

Edit Code Review Agent Settings | Greptile

Copy link
Copy Markdown
Contributor

@rita-gorokhod rita-gorokhod left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@gorohoroh gorohoroh changed the title CONTRIBUTING.md update (DOC-142) Update CONTRIBUTING.md (DOC-142) Dec 10, 2025
@gorohoroh gorohoroh changed the title Update CONTRIBUTING.md (DOC-142) Update CONTRIBUTING.md. Fixes DOC-142 Dec 10, 2025
@gorohoroh gorohoroh changed the title Update CONTRIBUTING.md. Fixes DOC-142 Update CONTRIBUTING.md. Fix DOC-142 Dec 10, 2025
@gorohoroh gorohoroh changed the title Update CONTRIBUTING.md. Fix DOC-142 Update CONTRIBUTING.md. Fix #DOC-142 Dec 10, 2025
@rita-gorokhod rita-gorokhod changed the base branch from main to rita-gorokhod-patch-3 December 10, 2025 10:10
@rita-gorokhod rita-gorokhod deleted the branch openops-cloud:main December 10, 2025 10:11
@rita-gorokhod rita-gorokhod reopened this Dec 10, 2025
Copy link
Copy Markdown
Contributor

@greptile-apps greptile-apps Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your free trial has ended. If you'd like to continue receiving code reviews, you can add a payment method here.

@rita-gorokhod rita-gorokhod changed the base branch from rita-gorokhod-patch-3 to main December 10, 2025 10:13
@sonarqubecloud
Copy link
Copy Markdown

@rita-gorokhod rita-gorokhod changed the title Update CONTRIBUTING.md. Fix #DOC-142 Update CONTRIBUTING.md with new instructions Dec 10, 2025
@rita-gorokhod rita-gorokhod merged commit 3ab5634 into openops-cloud:main Dec 10, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants