-
Notifications
You must be signed in to change notification settings - Fork 3
Documentation: Create dedicated CONTRIBUTING.md for developers #84
Copy link
Copy link
Open
Description
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.mdwith:- 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.mdfrom theREADME.md. - Remove the detailed "Local Development" section from the
README.mdto 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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels