Skip to content

Community Guidelines

Jump to bottom
Mo Abualruz edited this page Dec 12, 2025 · 3 revisions

Community Guidelines

Status: ✅ Complete

Last Updated: December 5, 2025

Overview

RiceCoder is built by and for the community. These guidelines help us maintain a welcoming, inclusive, and productive community where everyone can contribute and feel valued.

Table of Contents

Code of Conduct

Our Commitment

We are committed to providing a welcoming and inspiring community for all. We expect all community members to:

  • Be Respectful: Treat all community members with respect and dignity
  • Be Inclusive: Welcome people of all backgrounds and experiences
  • Be Collaborative: Work together to achieve common goals
  • Be Professional: Maintain professional standards in all interactions
  • Be Constructive: Provide helpful feedback and suggestions

Unacceptable Behavior

The following behaviors are not tolerated:

  • Harassment: Any form of harassment, bullying, or intimidation
  • Discrimination: Discrimination based on race, gender, sexual orientation, disability, or other characteristics
  • Abuse: Verbal abuse, personal attacks, or insults
  • Spam: Spam, self-promotion, or off-topic content
  • Illegal Activity: Any illegal activity or content

Enforcement

Community members who violate this code of conduct may be:

  • Warned by moderators
  • Temporarily suspended from the community
  • Permanently banned from the community

Community Values

Inclusivity

We believe that diversity strengthens our community. We welcome people of all backgrounds, experiences, and perspectives.

  • Respect Differences: Appreciate diverse viewpoints and experiences
  • Welcome Newcomers: Help new members feel welcome and supported
  • Provide Accessibility: Ensure our community is accessible to everyone
  • Use Inclusive Language: Avoid language that excludes or offends

Collaboration

We believe that great things are built together. We encourage collaboration and teamwork.

  • Share Knowledge: Help others learn and grow
  • Work Together: Collaborate on projects and initiatives
  • Support Each Other: Provide support and encouragement
  • Celebrate Success: Recognize and celebrate community achievements

Transparency

We believe in being open and honest with our community.

  • Share Information: Keep the community informed about decisions and changes
  • Be Honest: Be truthful and transparent in all communications
  • Explain Decisions: Explain the reasoning behind decisions
  • Listen to Feedback: Actively listen to community feedback

Quality

We believe in maintaining high standards for our community and project.

  • Maintain Standards: Uphold quality standards for code and contributions
  • Provide Feedback: Give constructive feedback to help improve contributions
  • Continuous Improvement: Continuously improve our processes and standards
  • Learn from Mistakes: Learn from mistakes and improve

Getting Involved

Ways to Contribute

There are many ways to contribute to RiceCoder:

  1. Code Contributions:

    • Fix bugs
    • Implement features
    • Improve performance
    • Refactor code

  2. Documentation:

    • Write guides and tutorials
    • Improve existing documentation
    • Create examples
    • Translate documentation

  3. Testing:

    • Report bugs
    • Test new features
    • Suggest improvements
    • Provide feedback

  4. Community Support:

    • Answer questions
    • Help new members
    • Moderate discussions
    • Organize events

  5. Design and UX:

    • Suggest UI/UX improvements
    • Create mockups and designs
    • Test usability
    • Provide feedback

Getting Started

  1. Read the Documentation: Familiarize yourself with RiceCoder
  2. Join the Community: Join our Discord or GitHub Discussions
  3. Find an Issue: Look for issues labeled "good first issue"
  4. Ask Questions: Don't hesitate to ask for help
  5. Start Contributing: Make your first contribution

Finding Issues to Work On

  • Good First Issue: Issues labeled "good first issue" are suitable for newcomers
  • Help Wanted: Issues labeled "help wanted" need community assistance
  • Feature Requests: Look for feature requests you're interested in
  • Bug Reports: Help fix reported bugs

Communication Guidelines

Channels

GitHub Issues: Report bugs and request features

  • Use clear, descriptive titles
  • Provide detailed descriptions
  • Include steps to reproduce (for bugs)
  • Include expected vs actual behavior

GitHub Discussions: Ask questions and discuss ideas

  • Use appropriate category
  • Search for existing discussions first
  • Be respectful and constructive
  • Stay on topic

Discord: Real-time chat and community support

  • Use appropriate channels
  • Be respectful and professional
  • Avoid spam and self-promotion
  • Help other community members

GitHub Discussions: For sensitive or private matters

Best Practices

  1. Be Clear and Concise:

    • Use clear language
    • Provide relevant details
    • Avoid unnecessary information
    • Use formatting for readability

  2. Be Respectful:

    • Treat others with respect
    • Avoid personal attacks
    • Disagree respectfully
    • Assume good intentions

  3. Be Constructive:

    • Provide helpful feedback
    • Suggest improvements
    • Offer solutions
    • Be supportive

  4. Search First:

    • Search for existing discussions
    • Check documentation
    • Look for similar issues
    • Avoid duplicates

Reporting Issues

Reporting Bugs

When reporting a bug, include:

  1. Clear Title: Descriptive title of the bug
  2. Description: What happened and what you expected
  3. Steps to Reproduce: How to reproduce the bug
  4. Environment: OS, version, configuration
  5. Logs: Error messages and logs
  6. Screenshots: Screenshots if applicable

Example:

Title: Code completion crashes when file has syntax errors

Description:
When I open a file with syntax errors, code completion crashes
and RiceCoder becomes unresponsive.

Steps to Reproduce:
1. Create a Rust file with syntax errors
2. Enable code completion
3. Try to get completions

Expected: Graceful error handling
Actual: RiceCoder crashes

Environment:
- OS: macOS 12.0
- RiceCoder: v0.1.3
- Rust: 1.75.0

Reporting Security Issues

For security issues, do not create a public issue. Instead:

  1. Use GitHub Security Advisories
  2. Include detailed description
  3. Include steps to reproduce
  4. Allow time for a fix before disclosure

Requesting Features

When requesting a feature, include:

  1. Clear Title: Descriptive title of the feature
  2. Use Case: Why you need this feature
  3. Description: What the feature should do
  4. Examples: Examples of how it would be used
  5. Alternatives: Alternative solutions you've considered

Example:

Title: Add support for custom code formatters

Use Case:
I want to use a custom code formatter that's specific to my project.

Description:
Allow users to configure custom code formatters in .agent/config.yaml
that will be used instead of the default formatter.

Example:
```yaml
formatters:
  rust: "my-custom-formatter"

Alternatives:

  • Use environment variables
  • Use command-line flags

---

## Contribution Process

### Step-by-Step Process

1. **Fork the Repository**:
   ```bash
   git clone https://github.com/YOUR_USERNAME/ricecoder.git
   cd ricecoder

  1. Create a Feature Branch:

    git checkout -b feature/my-feature

  2. Make Your Changes:

    • Write code
    • Add tests
    • Update documentation

  3. Commit Your Changes:

    git commit -am "feat: Add my feature"

  4. Push to Your Fork:

    git push origin feature/my-feature

  5. Create a Pull Request:

    • Go to GitHub
    • Click "New Pull Request"
    • Describe your changes
    • Link related issues

  6. Address Feedback:

    • Review comments
    • Make requested changes
    • Update your PR

  7. Merge:

    • Once approved, your PR will be merged

Pull Request Guidelines

  • Title: Clear, descriptive title
  • Description: Explain what and why
  • Tests: Include tests for new functionality
  • Documentation: Update docs if needed
  • Commits: Logical, atomic commits
  • Code Quality: Pass clippy and tests

Code Review Process

  1. Automated Checks:

    • Tests must pass
    • Code must pass clippy
    • Coverage must be adequate

  2. Manual Review:

    • Code review by maintainers
    • Feedback and suggestions
    • Approval or requested changes

  3. Merge:

    • Once approved, PR is merged
    • Contributor is credited

Community Roles

Maintainers

Maintainers are responsible for:

  • Reviewing and merging pull requests
  • Managing issues and discussions
  • Maintaining code quality
  • Releasing new versions
  • Enforcing community guidelines

Contributors

Contributors are community members who:

  • Submit pull requests
  • Report bugs
  • Request features
  • Help other community members
  • Improve documentation

Community Members

Community members are:

  • Users of RiceCoder
  • Participants in discussions
  • Reporters of issues
  • Supporters of the project

Conflict Resolution

Disagreements

If you disagree with someone in the community:

  1. Assume Good Intentions: Assume the other person means well
  2. Listen: Try to understand their perspective
  3. Discuss Respectfully: Have a respectful discussion
  4. Find Common Ground: Look for areas of agreement
  5. Escalate if Needed: Involve a moderator if necessary

Reporting Conflicts

If you experience a conflict or violation of community guidelines:

  1. Document the Issue: Keep records of the conflict
  2. Report to Moderators: Contact a moderator or maintainer
  3. Provide Details: Include relevant information
  4. Allow Investigation: Let moderators investigate
  5. Follow Resolution: Accept the resolution

Moderation

Moderators will:

  • Investigate reported issues
  • Gather information from all parties
  • Make fair and impartial decisions
  • Enforce community guidelines
  • Communicate decisions clearly

Community Events

Discussions

We regularly host discussions on:

  • Feature requests and ideas
  • Best practices and tips
  • Project updates and announcements
  • Community feedback and suggestions

Meetups

We organize virtual meetups for:

  • Networking and community building
  • Sharing knowledge and experiences
  • Discussing project direction
  • Celebrating community achievements

Hackathons

We occasionally organize hackathons for:

  • Building new features
  • Improving documentation
  • Fixing bugs
  • Community collaboration

Resources

Getting Help

Community Channels

Contributing Resources

Acknowledgments

We appreciate all community members who:

  • Contribute code and documentation
  • Report bugs and request features
  • Help other community members
  • Provide feedback and suggestions
  • Support the project

Thank you for being part of the RiceCoder community!

See Also

Last updated: December 5, 2025

Clone this wiki locally