Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 2.82 KB

contributing.md

File metadata and controls

43 lines (24 loc) · 2.82 KB
Raw

Contributing

We're thrilled that you're considering contributing to the project! All contributions are greatly appreciated, regardless if they are simple issue reporting, bug fixes, documentation changes, etc...

No contribution is too small and all help moving the project forward!

Submitting an bug report or feature request

If you find an bug or want to request a feature, open a new issue documenting it, please try to fill as much of the requested information as possible as that will help us dealing with the issue more effectively.

Pull Requests

When opening a new PR make sure to set up an informative title for it and provide as much details as you can in the PR's description so that it is clear what its intentions are. This helps in simplifying and speeding up the reviewing process.

If your PR is addressing an existing issue make sure that it references the issue (as per the Github PR Issues linking documentation) so that the two can be linked correctly (and the issue gets automatically closed on merge).

Smaller PRs are preferred since they are easier to review and merge quickly. If you're planning to make multiple unrelated (or loosely related) changes please consider splitting them in multiple PRs.

Not sure what to contribute on?

If you're looking for something to help us with, what we believe would be most valuable to us is to either: try to implement Next.js functionality which we currently don't support (which you can see in the Supported Versions and Features document), or help us fix existing issues.

For first time contributors, check out issues labeled as good first issue or help wanted.

Changeset

The repository uses Changesets to automate the versioning of the package and its changelog.

If you open a PR which contains functional changes (anything except documentation, testing, linting, CI, etc...) please provide a changeset by running (in the repository's root directory):

npm run changeset

The command will prompt you to choose the kind of changes you're making, select:

  • patch if your changes only contain backward compatible bug fixes,
  • minor if your changes add functionality in a backward compatible manner,
  • or major if your changes (bug fixes or functionality) aren't backward compatible.

The command will generate a randomly named markdown file inside the .changeset directory. Commit this file and include it in your PR.