crunchyman-ralph / slate

Slate is a toolkit for developing Shopify themes. It's designed to assist your workflow and speed up the process of developing, testing, and deploying themes.

⚠ Slate on Low Maintenance

Due to project priority and resource constraints, this project is currently on low maintenance. We recognize that there are a lot of activities around this package. However, we are unable to accommodate the maintenance this project requires.

What does this mean?

Slate won't have any dedicated maintainers during this period. All future work will be evaluated based on Shopify's own development needs.

For example:

• PRs for bug fixes will be addressed by Shopify developers if their own work is blocked; either by bugs that have not yet been fixed or if their own work could benefit from new Slate features that do not currently exist.
• Community PRs are always welcome! However, we cannot promise a quick turnaround time for reviewing, merging and publishing these updates. This is entirely up to the availability of Shopify developers and PR contributions will be addressed intermittently and when time permits.

Since there is no dedicated maintainer, there won't be any expectations for Shopify developers to address others' requests and/or issues, other than the ones that are currently being worked on.

Should I continue using Slate?

You may. As it is, Slate is still useful for Shopify themes development.

What happened? Why are you stopping? Will Shopify work on Slate in the future?

Due to Shopify priorities and resource constraints, we have decided to put more emphasis on other projects. We have plans to return to Slate once our priorities change. While evaluating the current state of Slate, there are two key developer workflows that we are not satisfied with:

• Local development - Slate is not a true local development environment
• File integrity (GitFlow and code version control) - Slate does not offer the ability to be the source of truth for theme files

We would like to address these two points above when we have our focus back on Slate.

This low maintenance period is time-boxed to 6 months from March 2019. We will re-visit and re-evaluate the project priority and plans for next steps.

---

Slate v1.0 is currently in beta. Expect more bugs than a final release. If you are migrating from using the previous version of Slate, please review the new documentation as there are breaking changes. Slate v1.0 has not yet been tested on Windows.

To view the previous version of Slate, visit the 0.x branch.

Slate empowers developers of all skill levels to build quality Shopify themes. Slate guides developers by providing a tested workflow and opinionated development toolkit, while also accommodating more established developers through advanced configuration.

🚀 Get started with a new Slate project

Documentation

Visit the official Slate documentation website for complete documentation Slate's concepts and technical details, as well as helpful guides!

Contributing

For help on setting up the repo locally, building, testing, and contributing please see CONTRIBUTING.md.

Code of Conduct

All developers who wish to contribute through code or issues, take a look at the Code of Conduct.

License

Copyright (c) 2018 Shopify. See LICENSE for further details.

Thanks

We would like to specifically thank the following projects, for the inspiration and help in regards to the creation of Slate:

• create-react-app
• Dynamo's Shopify Pipeline