Skip to content

docs: create contribution guidelines #5

Description

@codevalve

Create Contribution Guidelines

Description

Develop clear guidelines for project contributors:

Guidelines Content

  • Getting Started Guide
    • Development setup
    • Required tools
    • Local testing
  • Contribution Process
    • Fork and PR workflow
    • Branch naming
    • Commit message format
  • Code Standards
    • Shell script style
    • YAML formatting
    • Documentation requirements
  • Testing Requirements
    • What to test
    • How to test
    • Test documentation
  • PR Template
    • Checklist
    • Required information
    • Testing verification

Benefits

  • Consistent contributions
  • Easier review process
  • Maintained code quality
  • Better community engagement

Location

  • CONTRIBUTING.md in root directory
  • Referenced from README.md

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    priority-mediumImportant but not blocking MVP

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions