PrivateCoffee/tldraw
4
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 1
tldraw/CONTRIBUTING.md
Steve Ruiz 3cf4dae34d
Change licenses to tldraw (#2167) 
This PR updates the licenses across tldraw to a bespoke tldraw license.

The idea here is leverage dual licensing for revenue from companies
using tldraw. The source code and its distributions are provided under a
non-commercial license (tldraw) while we offer to sell / give out an
alternative exclusive-use license for companies who wish to use the
product for commercial purposes.

- [x] Add new license
- [x] Change licenses in package.jsons
- [x] Update READMEs
- [x] Update docs (separate repo PR)
- [x] Have alternative license in hand (US)
- [ ] Have alternative license in hand (UK)
- [x] Have sales contract in hand (US)
- [ ] Have sales contract in hand (UK)

### Change Type

- [x] `major` — Breaking change
2023-12-19 10:41:01 +00:00

1.9 KiB
Raw Blame History

Contributing

Thank you for your interest in contributing to tldraw! We welcome any contributions to the code base and the documentation.

Create an Issue!

Before submitting a pull request, it is strongly recommended to create create an issue first to discuss your proposed changes. This will help us to make sure that your changes are aligned with the project goals and that you are not duplicating work that is already in progress.

If you are not sure whether your changes are needed, feel free to create an issue anyway and we can discuss it there. Once we have agreed on the changes, you can start working on them.

Making Changes

To create a pull request:

  1. Fork and clone the repository
  2. Create a separate branch for your changes
  3. Make your changes, and ensure that it is formatted by Prettier and type-checks without errors in TypeScript
  4. Write tests that validate your change and/or fix.
  5. Run yarn build and then run tests with yarn test.
  6. Push your branch and open a PR. 🚀

Before your code is merged, you will need to sign our contributor license agreement, which is handled automatically via GitHub comments. Your PR will be reviewed and merged in within a day or two if everything looks good.

Please also see our Code of Conduct for our expectations around contributor culture.