Skip to content

docs: add CONTRIBUTING.md with development and contribution guidelines#233

Draft
onkar717 wants to merge 2 commits intoweb-servers:mainfrom
onkar717:docs/add-contributing-guide
Draft

docs: add CONTRIBUTING.md with development and contribution guidelines#233
onkar717 wants to merge 2 commits intoweb-servers:mainfrom
onkar717:docs/add-contributing-guide

Conversation

@onkar717
Copy link
Copy Markdown

@onkar717 onkar717 commented Mar 17, 2026

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:

  • Required development tools
  • Local setup and build steps
  • How to run unit and e2e tests
  • Linting and formatting checks
  • General PR workflow

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.

@onkar717 onkar717 force-pushed the docs/add-contributing-guide branch from e3276b9 to 710e023 Compare March 17, 2026 13:32
@mmadzin
Copy link
Copy Markdown
Collaborator

mmadzin commented Mar 18, 2026

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.

@mmadzin mmadzin self-assigned this Mar 18, 2026
@mmadzin mmadzin marked this pull request as draft March 18, 2026 12:56
@onkar717
Copy link
Copy Markdown
Author

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.

@onkar717
Copy link
Copy Markdown
Author

@mmadzin such many org have the sperate clear focused the CONTRIBUTING.md and README.md

Onkar added 2 commits March 21, 2026 22:37
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.
@onkar717 onkar717 force-pushed the docs/add-contributing-guide branch from 710e023 to 25b39c6 Compare March 21, 2026 17:41
@onkar717
Copy link
Copy Markdown
Author

I reworked CONTRIBUTING.md to be concise and strictly repository-focused.

I ran the following from this branch:

  • make help
  • make build
  • make lint-config
  • make test executes but currently fails in runtime due to an existing panic in internal/controller/webserver_controller_test.go (nil pointer dereference during controller test). This appears to be a current test/runtime issue rather than a docs issue.

@mmadzin

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add CONTRIBUTING.md to document development workflow for new contributors

2 participants