Skip to content

Latest commit

 

History

History
53 lines (37 loc) · 2.49 KB

CONTRIBUTING.md

File metadata and controls

53 lines (37 loc) · 2.49 KB
Raw

Contributing

Thank you for considering to contribute to Craft.js!

From proofreading, translating, writing tutorials or blog posts, improving the documentation, submitting bug reports and feature requests, or writing code, there are many ways to contribute. Upon contribution as per the all-contributors specification, your profile will be recognised in our README's contributors section.

To get started right away, have a look at our project tracker to check out a list of things that we'd like to work on right now.

If you are interested in proposing a new feature or have found a bug that you'd like to fix, please file a new issue.

Setup

  1. Fork this repository and create your branch from master
git clone https://github.com/your-name/craft.js
cd craft.js
  1. Install the dependencies and start the development server
> yarn install
> yarn dev
  1. Here are some additional npm scripts that might be useful
> yarn clean # clean all build files from all packages in the monorepo
> yarn build # create production build for all craftjs packages
> yarn lint # run tests across the monorepo
  1. Do your magic. 🎆 Be sure that the package(s) that you're working on can still be successfully built after you've applied your changes.
  2. Submit a pull request to merge the changes from your fork ❤️ (If your PR is not linked to an existing issue, then be sure to explain what your PR aims to accomplish)

Pull requests

Craft.js uses Changesets to track and publish new releases.

Therefore, when you submit a change that affects functionality (ie: fix a bug or add a new feature) to one of the packages (in the /packages/ folder), then you will need to create a new Changeset by running the following command:

yarn changeset

Typos and changes made to the /examples or the main /site do not require a changeset.

Currently Craft.js is still using major version 0.y.z, where y is only incremented when there's a major/breaking change. Hence, when creating a changeset:-

  • All backwards compatible changes and bug fixes should be labelled as a patch
  • Otherwise, it should be labelled as minor
  • major should not be used at the moment

License

By contributing, you agree that your contributions will be licensed under MIT License.