Skip to content

Latest commit

 

History

History
94 lines (57 loc) · 3.41 KB

CONTRIBUTING.md

File metadata and controls

94 lines (57 loc) · 3.41 KB
Raw

Contributing to TinaCMS

The following is a set of guidelines and tips for contributing to the TinaCMS and its packages.

How to Contribute

  • Reporting Bugs
  • Suggesting Enhancements
  • Writing Docs, Guides, or Blog Posts
  • Volunteering for User Testing

Contributing Code

Making Commits

TinaCMS uses Conventional Commits to generate CHANGELOG entries. Please make sure your commits follow this convention.

Please include the package name in the scope of your commit. For example:

fix(react-tinacms-editor): table row add and delete icons no longer overlap

Creating Packages

Packages in Tina are organized according to their name

Type Naming Convention Example Path
Core Tina @tinacms/* @tinacms/core
React react-tinacms-* react-tinacms-remark
Next.js next-tinacms-* next-tinacms-json
Gatsby gatsby-tinacms-* gatsby-tinacms-json
Demos demo-* demo-gatsby

Troubleshooting in Development

This section contains solutions to various problems you may run into when developing for TinaCMS.

I pulled down changes and now my packages won't build

The links between the local packages may have been broken. If this is the problem, then running npm run bootstrap should fix the issue.

Example error message

sh: tinacms-scripts: command not found

I can't add dependencies to a package

Linking prevents running npm install from directly inside a package from working. There are two ways to get around this issue.

  1. Add the package with lerna

    You can use lerna to add new dependencies to a package from the root of the repository:

    lerna add react --scope react-cms

    The downside of this approach is you can only add one dependency at a time. If you need to add many packages, you can use the next method.

  2. Add dependencies manually, then bootstrap

    The other approach is to manually add the dependencies to the package.json and then run npm run bootstrap from the root of the repository.

  3. When I run npm run bs it deletes the contents of a package?

    This sucks. Try running lerna clean and then running npm run bs again.

Failed to Compile: Module not found: Can't resolve 'some-tinacms-package'

There are two reasons this error might occur:

  1. The package did not link to some-tinacms-package

    This is likely the problem if some-tinacms-package is missing from the node_modules. If it is, do the following:

    • Make sure some-tinacms-package is listed in the package.json
    • Run npm run bootstrap from the root of the repo.

  2. some-tinacms-package was not built.

    This is likely the problem if: the build directory is missing; there are no .d.ts or .js files. To fix this issue simply run npm run build from the root of the repository.

Release Process

The TinaCMS core team releases frequently. Checkout the RELEASE.md file to see how to create a release.