Skip to content
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

Scarlett/update contributing #276

Merged
merged 5 commits into from
Feb 27, 2025
Merged

Scarlett/update contributing #276

merged 5 commits into from
Feb 27, 2025

Conversation

sattensil
Copy link
Collaborator

@sattensil sattensil commented Feb 25, 2025

Important

Updates CONTRIBUTING.md to introduce new contribution paths and improve guidance for contributors.

  • New Contribution Paths:
    • Introduces four ways to contribute: picking up existing issues, creating tickets, sharing use cases, and helping on Discord.
  • Bug Reports and Feature Requests:
    • Provides detailed instructions for submitting bug reports and feature requests via GitHub issue tracker.
  • Community Engagement:
    • Encourages joining Discord for real-time help and contribution discussions.
  • Removed Sections:
    • Removes redundant sections on bug reporting and feature requests, consolidating them into new contribution paths.

This description was created by Ellipsis for a002241. It will automatically update as commits are pushed.

Copy link

github-actions bot commented Feb 25, 2025

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

@sattensil
Copy link
Collaborator Author

I have read the CLA Document and I hereby sign the CLA

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to a002241 in 3 minutes and 5 seconds

More details
  • Looked at 73 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 6 drafted comments based on config settings.
1. CONTRIBUTING.md:5
  • Draft comment:
    Consider minimizing the personal anecdote to maintain a more formal and objective tone. While personal insights can be engaging, a more concise introduction might better serve all contributors.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 80%
    None
2. CONTRIBUTING.md:29
  • Draft comment:
    The Discord link is repeated in multiple sections. Consider defining a single reference or variable to ensure consistency and easier maintenance.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 80%
    None
3. CONTRIBUTING.md:17
  • Draft comment:
    The guidelines for feature requests and bug reports are clear and helpful. No issues found, but ensure this detailed structure is maintained in future updates.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 80%
    None
4. CONTRIBUTING.md:120
  • Draft comment:
    Consider using a lower-level header for 'Questions?' (e.g. '## Questions?') to maintain a consistent document hierarchy, since other sections are not top-level.
  • Reason this comment was not posted:
    Confidence changes required: 66% <= threshold 80%
    None
5. CONTRIBUTING.md:5
  • Draft comment:
    The first-person anecdote in this section adds a friendly tone, but consider if this personal narrative aligns with your project's overall documentation voice.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 80%
    None
6. CONTRIBUTING.md:37
  • Draft comment:
    Multiple H1-level headers (e.g. '# Contributing to Graphiti', '# From Idea to Pull Request', and '# Questions?') may confuse the document structure. Consider using a single H1 for the title and H2 for primary sections for clearer organization.
  • Reason this comment was not posted:
    Confidence changes required: 66% <= threshold 80%
    None

Workflow ID: wflow_euSHJjogM6ODOMz1


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@sattensil sattensil merged commit 93b8b02 into main Feb 27, 2025
6 of 7 checks passed
@sattensil sattensil deleted the scarlett/update-contributing branch February 27, 2025 16:42
@github-actions github-actions bot locked and limited conversation to collaborators Feb 27, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants