Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
67 lines (48 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

67 lines (48 loc) · 4.46 KB

Contributing

This guide will serve as a reference for contributing to the Deephaven.

Getting the source

Deephaven uses the Forking Workflow. In this workflow, the deephaven/deephaven-core repository contains a minimum number of branches, and development work happens in user-forked repositories.

To learn more see:

To get started quickly:

  1. Navigate to https://github.com/deephaven/deephaven-core.
  2. Click Fork in the top right corner.
  3. git clone git@github.com:<username>/deephaven-core.git
  4. Commit changes to your own branches in your forked repository.

For details on working with git on GitHub, see:

Forked repositories do not have access to the same tokens/secrets as the deephaven/deephaven-core repository, so GitHub actions will fail. To disable GitHub actions in your forked repository, go to "Actions" -> "Disable Actions" in your forked repository settings (https://github.com/<username>/deephaven-core/settings/actions).

Over time, forks will get out of sync with the upstream repository. To stay up to date, either:

  • Navigate to https://github.com/<username>/deephaven-core and click on Fetch upstream, or
  • Follow these directions on Syncing A Fork.

Building and Running

For instructions on building and running, see Build and launch from source.

Creating a Pull Request

Pull requests can be created through the GitHub website or through the GitHub CLI.

GitHub Web

Follow the directions in Creating A Pull Request From A Fork.

GitHub CLI

  1. Install GitHub command line tool.
  2. On the command line, cd into your checked-out fork/branch.
  3. gh pr create -f -w
    • Use deephaven/deephaven-core as the base repository.
    • Use <username>/deephaven-core as the repository to push to.
  4. Your changes should automatically get pushed, and then a new pull request with your changes should open up in your browser.
  5. Complete the information in the pull request and click Create pull request.

For more information, see:

Labels

  • Each pull request must have a ReleaseNotesNeeded label if a user can perceive the changes. Build or testing-only changes should have a NoReleaseNotesNeeded label.
  • Each pull request must have a DocumentationNeeded label if the user guide should be updated. Pull requests that do not require a user guide update should have a NoDocumentationNeeded label.

Styleguide

The styleguide is applied globally to the entire project, except for generated code that gets checked in. To apply the styleguide, run ./gradlew spotlessApply.

Deephaven Contributor License Agreement (CLA)

The Deephaven Contributor License Agreement (CLA) must be accepted before a pull request can be merged. A bot monitors all pull requests. Follow the instructions from the bot in the pull request comments to accept the CLA. The Deephaven CLA and associated signatures are maintained at https://github.com/deephaven/cla.