Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
99 lines (57 loc) · 5.73 KB

CONTRIBUTING.md

File metadata and controls

99 lines (57 loc) · 5.73 KB
Raw

Contributing

Thank you for investing your time in contributing to KubeRay project!

Read our Code of Conduct to keep our community approachable and respectable.

This guide details how to use issues and pull requests to improve KubeRay project.

General Guidelines

Getting involved

Kuberay has an active community of developers. Here’s how to get involved with the Kuberay community:

Join our community: Join Ray community slack (search for Kuberay channel) or use our discussion board to ask questions and get answers.

Please see Github Issue section below to file bug & feature requests.

Pull Requests

Make sure to keep Pull Requests small and functional to make them easier to review, understand, and look up in commit history. This repository uses "Squash and Commit" to keep our history clean and make it easier to revert changes based on PR.

Adding the appropriate documentation, unit tests and e2e tests as part of a feature is the responsibility of the feature owner, whether it is done in the same Pull Request or not.

Pull Requests should follow the "subject: message" format, where the subject describes what part of the code is being modified.

Refer to the template for more information on what goes into a PR description.

Design Docs

A contributor proposes a design with a PR on the repository to allow for revisions and discussions. If a design needs to be discussed before formulating a document for it, make use of Google doc and GitHub issue to involve the community on the discussion.

If a PR changes component boundaries, API contracts, or CRD schemas, the corresponding design doc or DEVELOPMENT.md must be updated in the same PR (or a linked follow-up). Examples of changes that require doc updates:

  • Adding or removing a CRD field in ray-operator/apis/ray/v1/*_types.go
  • Changing how controllers interact with webhooks or batch schedulers
  • Modifying the batch scheduler plugin interface
  • Altering the relationship between ray-operator/ and apiserver/ modules

GitHub Issues

GitHub Issues are used to file bugs, work items, and feature requests with actionable items/issues (Please refer to the "Reporting Bugs/Feature Requests" section below for more information).

Reporting Bugs/Feature Requests

We welcome you to use the GitHub issue tracker to report bugs or suggest features that have actionable items/issues (as opposed to introducing a feature request on GitHub Discussions).

When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:

  • A reproducible test case or series of steps
  • The version of the code being used
  • Any modifications you've made relevant to the bug
  • Anything unusual about your environment or deployment

Contributing via Pull Requests

Find interesting issue

If you spot a problem with the problem, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using issue template.

Solve an issue

KubeRay has subproject and each of them may have different development and testing procedure. Please check DEVELOPMENT.md in sub folder to get familiar with running and testing codes.

Open a Pull request

When you're done making the changes, open a pull request and fill PR template so we can better review your PR. The template helps reviewers understand your changes and the purpose of your pull request.

Don't forget to link PR to issue if you are solving one.

If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

Release Acknowledgements

Once your PR is merged, your contributions will be acknowledged in every release, see Release Notes for more details.

Maintaining AI Context

This repository includes context files that help AI coding agents work reliably in the codebase: CLAUDE.md (root conventions), .cursor/rules/ and .claude/rules/ (module-specific rules).

When to update context files

  • Reviewer catches a pattern issue on an AI-generated PR: add a rule to the relevant .cursor/rules/ or .claude/rules/ file, or CLAUDE.md, to prevent the same mistake
  • New generated files or API surfaces added: update the generated files registry in CLAUDE.md
  • Module boundaries change: update the corresponding .cursor/rules/ and .claude/rules/ files and depguard rules in .golangci.yml

Rule lifecycle

  • New rules should be specific and actionable (e.g., "never edit zz_generated.deepcopy.go")
  • Prefer lint rules over prose warnings — lint rules are deterministic and enforced in CI
  • When updating module rules, change both .cursor/rules/ and .claude/rules/ in the same PR (body content must stay in sync; only frontmatter differs)
  • Periodically audit context files: remove lines that no longer prevent real failures
  • Treat context files as a living list of codebase conventions, not permanent configuration

Finding contributions to work on

Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' and 'good first issue' issues are a great place to start.