Skip to content

Documentation: Create dedicated CONTRIBUTING.md for developers #84

@josephaw1022

Description

@josephaw1022

Description

Currently, information for developers and contributors is located at the bottom of the README.md. To keep the README concise and focused on users/consumers, we should move the developer-specific instructions to a dedicated CONTRIBUTING.md (or DEVELOPER.md) file.

Expected Changes

  • Create CONTRIBUTING.md with:
    • Prerequisites (Go, Task, Kind, Docker, etc.)
    • Local development workflow (task quick-dev)
    • In-cluster deployment workflow (task quick-deploy)
    • Any other contributor guidelines.
  • Link to CONTRIBUTING.md from the README.md.
  • Remove the detailed "Local Development" section from the README.md to reduce clutter.

Why is this needed?

It improves the readability of the main README.md and provides a standard location for potential contributors to find onboarding information.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    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