Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

48 lines (34 loc) · 2.7 KB
Raw

Contributing

This guide will serve as a reference for contributing to Jpy.

Getting the source

Jpy uses the Forking Workflow. In this workflow, the jpy-consortium/jpy 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/jpy-consortium/jpy.
  2. Click Fork in the top right corner.
  3. git clone [email protected]:<username>/jpy.git
  4. Commit changes to your own branches in your forked repository.

Forked repositories do not have access to the same tokens/secrets as the jpy-consortium/jpy depository, so GitHub actions that depend upon secrets will fail. If you experience this problem, disable the offending GitHub action. To disable GitHub actions in your forked repository, go to "Actions" -> "Disable Actions" in your forked repository settings (https://github.com/<username>/jpy/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>/jpy and click on Fetch upstream, or
  • Follow these directions on Syncing A Fork.

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 jpy-consortium/jpy as the base repository.
    • Use <username>/jpy 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: