Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add CONTRIBUTING.md #330

Open
yorugac opened this issue Nov 4, 2023 · 0 comments
Open

Add CONTRIBUTING.md #330

yorugac opened this issue Nov 4, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation maintenance

Comments

@yorugac
Copy link
Collaborator

yorugac commented Nov 4, 2023

Feature Description

Contributors in k6-operator has been finding their own path, and with a very good success rate, IMHO. But recently it has been raised a few times that a contributor guide would be helpful.
It's also quite noticeable that the Helm support is adding up to complexity.

Suggested Solution (optional)

Some initial thoughts:

  • it is preferable to have an issue and some discussion prior to opening a PR
  • move out development section from README.md to CONTRIBUTING.md and expand it as necessary
  • describe how PRs are tested
  • maybe make a separation of different types of PR. Case in study: Allow multiple replicas to be configured via helm chart #328

Already existing or connected issues / PRs (optional)

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation maintenance
Projects
None yet
Development

No branches or pull requests

1 participant