Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.88 KB

CONTRIBUTING.md

File metadata and controls

34 lines (21 loc) · 1.88 KB
Raw

Contributing

Thanks for wanting to make a contribution and wanting to improve this library for everyone! This repository uses Typescript so please continue to do so, you can always reach out in the repo or the discord. This is a guideline, use your initiative, if you don't think it makes sense to do a step in here, don't bother it's normally okay. we're chill.

How to Contribute

  1. Fork and clone the repo
  2. Run yarn install to install dependencies
  3. Create a branch for your PR with git checkout -b pr-type/issue-number-your-branch-name
  4. Let's get cooking! 👨🏻‍🍳🥓

You can also just Open in GitHub Codespaces.

Commit Guidelines

Be sure your commit messages follow this specification: https://www.conventionalcommits.org/en/v1.0.0-beta.4/

Storybook

If you're adding a brand new feature, you need to make sure you add a storybook entry, here's a few tips:

  • Keep the story simple & show the essence of the component, remember some people may be looking at using drei for the first time & it's important the stories are clear and concise.
  • Keep assets minimal (3D Models, textures) to avoid bloating the repository
  • If you think a more involved example is necessary, you can always add a codesandbox to the main README while keeping the story minimalistic

Publishing

We use semantic-release to deploy the package. Because of this only certain commits will trigger the action of creating a release:

  • fix: will create a 0.0.x version
  • feat: will create a 0.x.0 version
  • BREAKING CHANGE: will create a x.0.0 version

We release on master branch. Any other commits will not fire a release.