Skip to content

Commit

Permalink
Update docs to reference 0.x branch
Browse files Browse the repository at this point in the history
  • Loading branch information
t-kelly committed May 3, 2018
1 parent 90e9d95 commit 7324d0b
Show file tree
Hide file tree
Showing 7 changed files with 120 additions and 80 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

### Checklist
For contributors:
- [ ] I have [updated the docs](https://github.com/Shopify/slate/blob/master/CONTRIBUTING.md#documentation) to reflect these changes, if applicable.
- [ ] I have [updated the docs](https://github.com/Shopify/slate/blob/0.x/CONTRIBUTING.md#documentation) to reflect these changes, if applicable.

For maintainers:
- [ ] I have :tophat:'d these changes.
Expand Down
47 changes: 31 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# How to contribute
We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or just correct a typo, please feel free to do so, as long as you follow our [Code of Conduct](https://github.com/Shopify/slate/blob/master/CODE_OF_CONDUCT.md).

We ❤️ pull requests. If you'd like to fix a bug, contribute a feature or just correct a typo, please feel free to do so, as long as you follow our [Code of Conduct](https://github.com/Shopify/slate/blob/0.x/CODE_OF_CONDUCT.md).

If you're thinking of adding a big new feature, consider opening an issue first to discuss it to ensure it aligns to the direction of the project (and potentially save yourself some time!).

Expand All @@ -10,38 +11,45 @@ The `slate-theme` scaffolding is [intentionally barebones](https://shopify.githu
## Getting Started

To start working on the codebase, first fork the repo, then clone it:

```
git clone [email protected]:your-username/slate.git
```
*Note: replace "your-username" with your GitHub handle*

_Note: replace "your-username" with your GitHub handle_

Install all package dependencies and link local packages:

```
npm run bootstrap
```

Write some features. Run the tests with:

```
npm test
```

## View changes to `slate-theme` package in a live store

Create a config.yml file with private app settings from your shop. See [config-sample.yml](https://github.com/Shopify/slate/blob/master/packages/slate-theme/config-sample.yml) as an example.
Create a config.yml file with private app settings from your shop. See [config-sample.yml](https://github.com/Shopify/slate/blob/0.x/packages/slate-theme/config-sample.yml) as an example.

Go to the `slate-theme` package:

```
cd packages/slate-theme
```

Deploy Slate to your shop and start testing your feature.

```
slate deploy
```

## Folder Structure

The following documents the folder structure for this project and what the purpose of each folder is:

```
+-- docs/ ** API docs that live at https://shopify.github.io/slate
+-- scripts/ ** Scripts used for development such as deployment and CI scripts
Expand All @@ -60,15 +68,19 @@ reflect this. The docs live inside the `docs/` folder and are hosted
at `https://shopify.github.io/slate`.

To run the docs locally, first install the ruby dependencies:

```
bundle install
```
*If you are having troubles setting up jekyll, see https://jekyllrb.com/docs/installation/*

_If you are having troubles setting up jekyll, see https://jekyllrb.com/docs/installation/_

Generate the docs:

```
jekyll serve -s docs
```

If you get a permission error, try `bundle exec jekyll serve -s docs`

The documentation will then be visible at:
Expand All @@ -79,47 +91,50 @@ The documentation will then be visible at:
The changelog is updated by the repo's maintainers since a [personal access token](https://github.com/settings/tokens) with repository access is needed to handle GitHub's API call limits.

If this is your first time generating changelog entries, add your personal access token with `public_repo` privileges to the `GITHUB_AUTH` environment variable by adding the following to your `.bashrc` file:

```
# Lerna Changelog Personal Access Token for shopify/slate repo
export GITHUB_AUTH=your_personal_access_token
```
*Note: replace "your_personal_access_token" with your GitHub personal access token*

_Note: replace "your_personal_access_token" with your GitHub personal access token_

Run the changelog generator:

```
npm run changelog
```

If nothing appears, you may not have any PRs tagged with appropriate labels in this release or you may have already published those changes. If you just released `v0.12.1` and the previous version was `v0.12.0`, run the following command to get the changes since `v0.12.0`:

```
npm run changelog -- --tag-from=v0.12.0
```

Copy the generated markdown from your terminal into [CHANGELOG.md](https://github.com/Shopify/slate/blob/master/CHANGELOG.md) and add any additional comments you wish to include. If the title of the autogenerated changelog is `Unreleased`, make sure you change it the new version name.
Copy the generated markdown from your terminal into [CHANGELOG.md](https://github.com/Shopify/slate/blob/0.x/CHANGELOG.md) and add any additional comments you wish to include. If the title of the autogenerated changelog is `Unreleased`, make sure you change it the new version name.

Commit the changes directly to `master` branch, with a commit title of:

```
Changelog vX.X.X
```
*Note: replace "X.X.X" with new repo version number*

Finally, paste the updates you made to the changelog in the release tag notes, see example: [v0.10.0 tag notes](https://github.com/Shopify/slate/releases/tag/v0.10.0).

_Note: replace "X.X.X" with new repo version number_

Finally, paste the updates you made to the changelog in the release tag notes, see example: [v0.10.0 tag notes](https://github.com/Shopify/slate/releases/tag/v0.10.0).

## Publishing

1. Merge any changes you want to include in your next release into `master`.
1. Merge any changes you want to include in your next release into `master`.

_Note: If you are merging multiple PRs into `master` with a single PR (e.g. you are merging a working branch called v0.11.0 with multiple fixes made from multiple PRs into `master`), then **do not squash and merge this PR** because you will loose valuable details in the auto generated changelog_

*Note: If you are merging multiple PRs into `master` with a single PR (e.g. you are merging a working branch called v0.11.0 with multiple fixes made from multiple PRs into `master`), then **do not squash and merge this PR** because you will loose valuable details in the auto generated changelog*
2. Update the [CHANGELOG.md](https://github.com/Shopify/slate/blob/0.x/CHANGELOG.md) as described above

2. Update the [CHANGELOG.md](https://github.com/Shopify/slate/blob/master/CHANGELOG.md) as described above
3. To select a new version number, publish packages to NPM, generate and deploy new `slate-theme` zips, run:

3. To select a new version number, publish packages to NPM, generate and deploy new `slate-theme` zips, run:
```
npm run publish
```

*Note: Make sure you are logged into your Shopify NPM account before publishing*


_Note: Make sure you are logged into your Shopify NPM account before publishing_
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Slate

[![CircleCI](https://circleci.com/gh/Shopify/slate.svg?style=svg&circle-token=f18ea06638792678e7dbfa1b8413570cd2896dff)](https://circleci.com/gh/Shopify/slate)

> ⓘ We're busy working on the next version of Slate which introduces a ton of cool new features to Shopify Theme development. Take a look in the [1.x branch](https://github.com/Shopify/slate/tree/1.x), give it a spin, and let us know what you think!
> **This branch is for Slate v0**. For the latest version of Slate, take a look in the [master branch](https://github.com/Shopify/slate).
Slate is a theme scaffold and command line tool for developing Shopify themes. It is designed to assist your development workflow and speed up the process of developing, testing, and deploying themes to Shopify stores.

It allows you to sync local files with your live shop, deploy to multiple environments at the same time, and organize stylesheets and scripts in a flexible way.

----------
---

## Documentation

Expand All @@ -16,15 +17,15 @@ For full API documentation, go check out the [API docs](https://shopify.github.i
## Contributing

For help on setting up the repo locally, building, testing, and contributing
please see [CONTRIBUTING.md](https://github.com/Shopify/slate/blob/master/CONTRIBUTING.md).
please see [CONTRIBUTING.md](https://github.com/Shopify/slate/blob/0.x/CONTRIBUTING.md).

## Code of Conduct

All developers who wish to contribute through code or issues, take a look at the
[Code of Conduct](https://github.com/Shopify/slate/blob/master/CODE_OF_CONDUCT.md).
[Code of Conduct](https://github.com/Shopify/slate/blob/0.x/CODE_OF_CONDUCT.md).

## License

MIT, see [LICENSE](http://github.com/Shopify/slate/blob/master/LICENSE) for details.
MIT, see [LICENSE](http://github.com/Shopify/slate/blob/0.x/LICENSE) for details.

<img src="https://cdn.shopify.com/shopify-marketing_assets/builds/19.0.0/shopify-full-color-black.svg" width="200" />
Loading

0 comments on commit 7324d0b

Please sign in to comment.