The tinacms from blaggacao

Getting Started

Development

To get started:

git clone [email protected]:tinacms/tinacms.git
cd tinacms
npm install && npm run bootstrap
npm run build

# Start Gatsby demo
cd packages/demo-gatsby
npm run start

Do not run npm install from inside the packages directory

TinaCMS uses Lerna to manage dependencies when developing locally. This allows the various packages to reference each other via symlinks. Running npm install from within a package replaces the symlinks with references to the packages in the npm registry.

Commands

Commands	Description
npm run bootstrap	Install dependencies and link local packages.
npm run build	Build all packages.
npm run watch	Watch all packages for rebuilds.
npm run test	Run tests for all packages.
lerna run build --scope <package>	Build only <package>.

Testing With External Projects

Linking apps to a monorepo can be tricky. Tools like npm link are buggy and introduce inconsistencies with module resolution. If multiple modules rely on the same package you can easily end up with multiple instances of that package, this is problematic for packages like react which expect only one instance.

@tinacms/webpack-helpers provides tools and instructions for testing local TinaCMS changes on external websites.

Release Process

Tina has two main branches:

master: The bleeding edge of tinacms
latest: The current stable release

The flow of changes therefore looks like:

fix-some-bug => master => latest

This is a weekly process:

On Monday master is merged into latest which is then published to npm.
Hot fixes are cherry picked onto latest and then published.
Prereleases are created off of master whenever they're needed.

With this process:

critical fixes are published as soon as possible
new features and minor fixes take 3-5 days to be published

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_Forestry.io 💵	_NCPhillips 📆 💻 📝 🐛 📖 🤔 🚇 🚧 👀 ⚠️	_DJ 📆 💻 📝 🐛 📖 🤔 🚧 👀 ⚠️	_{Scott Byrne} 🎨 💻 👀 🚧 📖 📝	_{James O'Halloran} 📆 🐛 🤔 🚧 👀 ⚠️ 💻 📝	_{Kendall Strautman} 🎨 📆 🐛 🤔 🚧 📢 👀 💻 📝	_{Nichlas Wærnes Andersen} 💻 🎨 🤔
_Jordan 📆 📢 🤔 🐛 🚇 📖 💻	_{Frank Taillandier} 👀 📖 📆 📓 🐛 💻	_{Scott Gallant} 📖 📢 🔍 📝	_{Mitch MacKenzie} 📓 📝	_zacchg 📓	_{Lyle Underwood} 🐛 💻	_Laura1111999 📖
_{Thom Krupa} 📓	_{Michael Gauthier} 📓 📖	_{dcgoodwin2112} 📖	_akshayknz 📖	_{Adam Silverstein} 📖	_{Brad McGonigle} 💻	_{Jake Coxon} 💻
_{Ladislav Prskavec} 💻	_{Bolarinwa Balogun} 🚇	_{Mason Medeiros} 📓	_ironsean 📓	_kyp 🐛	_{Vladislav Shkodin} 🐛	_{maciek_grzybek} 🤔 💻 🚇
_weibenfalk 📹 📝 💻	_{David Bergeron} 🐛	_{Kellan Martin} 💻	_{Jon Miller} 🤔	_Paul 🐛	_{Chris Flannery} 💻 📖	_{Jefferson Bledsoe} ⚠️
_Kenia 💻	_{Andrew James} 💻	_{Zach B} 📢	_{Jyoti Puri} 💻	_nibtime 💻 🐛	_{Johan Soulet} 💻 🐛	_{Cleiton Pereira} 🐛
_chrisdmacrae 🚇 💬 🤔	_jhuggett 💻	_{Nicolas Cisco} 💻 ⚠️	_{Hungry Bear Studio} 💻	_{Alex Barbato} 💻	_{Dani Tulp} 💻	_PaulBunker 💻
_{JavaScript Joe} 💻	_{Madelyn Eriksen} 📝	_{Marc Mintel} 🚇 💻 🐛	_{Jeff See} 🚇	_{Brandon Landfried} 🐛	_{Chad Johnson} 🐛