Skip to content

Latest commit

 

History

History
52 lines (33 loc) · 2.33 KB

CONTRIBUTING.md

File metadata and controls

52 lines (33 loc) · 2.33 KB

Contributing

Contributions are always welcome, no matter how large or small!

We want this community to be friendly and respectful to each other. Please follow it in all your interactions with the project. Before contributing, please read the code of conduct.

Setup

We automate some common tasks, like code formatting, linting, and release notes, using tools from the Javascript ecosystem. We use a tool called Husky to manage our git hooks.

To enable Husky, run the following commands in the root repo directory:

yarn install

Development workflow

  1. Do your changes
  2. Test them in the example app and via swift test
  3. Consider adding a changeset via yarn changeset
  4. Open a PR and describe your change

Changesets

We use a tool called Changesets to manage our releases. If you make a significant change that justifies a version bump you can add one by running yarn changeset.

We use semantic versioning. The gist is:

MAJOR version when you make incompatible API changes MINOR version when you add functionality in a backward compatible manner PATCH version when you make backward compatible bug fixes

Minor and patch version changes typically only need one line of explanation. Major version bumps should include an explanation of the breaking changes and upgrade steps.

Automated releases

Once your PR with a changeset merges, an automated GitHub workflow kicks into gears and prepares a new release PR. You will automatically be tagged in that PR and can follow the release to see when your changes become publicly available.

Sending a pull request

Working on your first pull request? You can learn how from this free series: How to Contribute to an Open Source Project on GitHub.

When you're sending a pull request:

  • Prefer small pull requests focused on one change.
  • Verify that linters and tests are passing.
  • Review the documentation to make sure it looks good.
  • Follow the pull request template when opening a pull request.
  • For pull requests that change the API or implementation, discuss with maintainers first by opening an issue.