Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (45 loc) · 2.74 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 2.74 KB
Raw

Contributing to Reactive Data Client

Getting Started

Use the /initialize skill to set up your development environment.

Bug Reports

  • Ensure your issue has not already been reported. It may already be fixed!
  • Include the steps you carried out to produce the problem.
  • Include the behavior you observed along with the behavior you expected, and why you expected it.
  • Include any relevant stack traces or debugging output.
  • Ensure you captured relevant network inspector screenshots
  • Ensure Browser Devtools screenshots or state and action dumps

Feature Requests

We welcome feedback with or without pull requests. If you have an idea for how to improve the project, great! All we ask is that you take the time to write a clear and concise explanation of what need you are trying to solve. If you have thoughts on how it can be solved, include those too!

The best way to see a feature added, however, is to submit a pull request.

If your idea requires design considerations, it's best to start a discussion.

Pull Requests

  • Before creating your pull request, it's usually worth asking if the code you're planning on writing will actually be considered for merging. You can do this by opening an issue and asking. It may also help give the maintainers context for when the time comes to review your code.

  • Ensure your commit messages are well-written. They are source material for the pull request description.

  • Fill in the pull request template. Its comments explain what each section needs.

  • Add tests for your feature. You should be able to look at other tests for examples. If you're unsure, don't hesitate to open an issue and ask! When you change code under packages/, run yarn test:coverage before you open the PR and make sure coverage doesn't decrease.

  • Add a changeset for user-facing changes in published packages:

    • Use the /changeset skill to generate changesets and update docs.
    • If doing manually: run yarn changeset from repo root once per distinct change.

  • If you changed package types, docs or skills, regenerate the committed outputs: merge master, run yarn copy:websitetypes and yarn build:skills, and commit the result. The regenerate check fails until they're up to date.

  • Submit your pull request!

Support Requests

Support is available in our discord channel