Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 1.78 KB

CONTRIBUTING.md

File metadata and controls

40 lines (30 loc) · 1.78 KB
Raw

Contributing to rules_haskell

Contribution Process

  1. Explain your idea and discuss your plan with members of the team. The best way to do this is to create an issue or comment on an existing issue.
  2. Prepare a Git commit(s) with your change in a new branch. Don't forget to add tests. Run the existing tests with bazel test //.... Update the README.md, if appropriate.
  3. Create a pull request. This will start the code review process. All submissions, including submissions by project members, require review.
  4. You may be asked to make some changes. Our continuous integration bots will test your change automatically on supported platforms. Once everything looks good, your change will be merged.

Please also refer to the maintenance instructions for maintenance-like contributions.

Setting Up Your Development Environment

Read how to set up your development environment.

Bazel Remote Cache

The remote cache configuration for this repository is stored in .bazelrc and grouped under the name, remote-cache. It is configured to allow read-only access for all clients and read-write for CI.

To enable the remote cache,

  1. Add build --remote_header=x-buildbuddy-api-key=${buildbuddy_api_key} to .bazelrc.auth at the root of the workspace, replacing ${buildbuddy_api_key} with the actual API key value.
  2. Add build --config=remote-cache to .bazelrc.local at the root of the workspace.