Skip to content

Contributing Guidelines & Community Guide #662

Description

@DokaIzk

Title: docs: update contributing guidelines with code style, review process, and community standards

Complexity: medium

Time Estimate: 5-7 hours

Description:
Update and expand CONTRIBUTING.md with clear guidelines for all contribution types. Cover code style, commit conventions, PR process, and community expectations.

Deliverables:

  • Code Style Guidelines

    • Python (PEP 8, type hints, linting)
    • TypeScript/JavaScript (ESLint, Prettier)
    • Rust (clippy, fmt)
    • CSS/Tailwind class organization
    • SQL (formatting, naming conventions)
  • Git Workflow Guide

    • Branching strategy (main/develop)
    • Commit message conventions (Conventional Commits)
    • Force push rules
    • Squashing vs rebasing
    • Cherry-picking policy
  • Pull Request Process

    • PR title and description template
    • Required checks and reviews
    • How to respond to review feedback
    • When to request changes vs approve
    • Merging strategy (squash/rebase/merge)
  • Issue Management

    • Issue labeling system
    • Triaging new issues
    • Issue prioritization
    • Issue assignment procedures
  • Community Standards

    • Code of conduct
    • Communication norms (Slack, GitHub)
    • Resolving conflicts
    • Welcoming new contributors
    • Mentorship opportunities
  • Documentation Contributing

    • How to write docs
    • Documentation style guide
    • Adding to Docusaurus
    • Reviewing docs PRs
  • Contributor Recognition

    • Contributors list/hall of fame
    • Recognition system
    • Swag/rewards for major contributions
    • Becoming a maintainer

Problem Context:
Contributing guidelines are minimal. Code style is inconsistent. Review process unclear. Hard to onboard new contributors.

Scope:

  • Update CONTRIBUTING.md in root
  • Create detailed guides in docs/contributing/
  • Link to existing style guides (black, ESLint)
  • Include examples of good PRs

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programbugSomething isn't workingdocumentationImprovements or additions to documentationfeaturemedium

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions