docs: add CONTRIBUTING.md with development and contribution guidelines#233
docs: add CONTRIBUTING.md with development and contribution guidelines#233onkar717 wants to merge 2 commits intoweb-servers:mainfrom
Conversation
e3276b9 to
710e023
Compare
|
It looks like it's AI generated. It contains lots of redundant information from already existing documentation and it also contains multiple mistakes. Please run the commands from the suggested documentation and make sure it works. |
|
Thanks for the feedback. I reviewed the existing project documentation and prepared this guide based on the current README, Makefile targets, and repository structure. I only used AI assistance for minor rephrasing and formatting, but I agree the document should be more concise and strictly project-focused. I'll rework the CONTRIBUTING.md to remove redundant information and ensure all commands are verified locally. If some parts fit better in the README instead, I can also move them there. I'll push an updated version shortly. |
|
@mmadzin such many org have the sperate clear focused the CONTRIBUTING.md and README.md |
Add a contributor guide describing how to set up the project locally, build the operator, and run tests. Includes: - Development prerequisites (Go, kubectl/oc, container tools) - Local setup and build instructions - How to run unit and e2e tests - Linting and code style checks - Basic PR submission workflow This should help new contributors get started more easily.
710e023 to
25b39c6
Compare
|
I reworked CONTRIBUTING.md to be concise and strictly repository-focused. I ran the following from this branch:
|
Summary
Add a CONTRIBUTING.md file to help new contributors understand how to set up the project, run tests, and submit changes.
This guide was prepared after reviewing the repository build system, Makefile targets, and existing documentation.
Related issue
Fixes #232
What is included
This adds a basic contributor guide covering:
Notes
This is a documentation-only change and does not modify any functionality.
The content was prepared by reviewing the existing README, Makefile targets, and repository structure.