Skip to content
This repository has been archived by the owner on Mar 26, 2023. It is now read-only.

Commit

Permalink
Publisshed new release 2.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
blanklob committed Jan 29, 2022
2 parents 47201e5 + c069fdb commit 85cb3bb
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 24 deletions.
5 changes: 3 additions & 2 deletions .github/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@

All notable changes to this project will be documented in this file.

> 28 December 2022 v2.0.0
> 29 December 2022 v2.0.0
-
- ✨ Removed all unnecessary configuation files that depend on users like editorconfig etc..
- ✨ Added a Helium CLI based on Esbuild for fast build times.
- 🔥 Changed some utility classes.
- ⏫ Removed some dependecies amd some deprecated Shopify filters.
- 🐛 Fixed issues and refactored code.
Expand Down
22 changes: 9 additions & 13 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,21 @@ We're really glad you're reading this, because we would love to have more develo

## Before contributing

If you encounter a bug or think of a useful feature for Workflow, please [create a new issue](https://github.com/younessidbakkasse/workflow/issues/new). Creating an issue before jumping into code ensures we can discuss it and determine whether it aligns with the direction of the theme.
If you encounter a bug or think of a useful feature for Helium, please [create a new issue](https://github.com/idbakkasse/helium/issues/new). Creating an issue before jumping into code ensures we can discuss it and determine whether it aligns with the direction of the theme.

If you want to contribute to the theme, regardless of whether it's a small bug fix or correcting a typo, please feel free to do so. Any help goes a long way! Also, contributions aren't necessarily all code related. Other contributions can be in the form of issues, pull requests, discussions, etc.

## Scope

This Github repository exists for the theme development community to discuss and solve problems directly related to Workflow. It **is not the place** to discuss general theme development problems, nor the place to seek help for non-Workflow related problems.
This Github repository exists for the theme development community to discuss and solve problems directly related to Helium. It **is not the place** to discuss general theme development problems, nor the place to seek help for non-related problems.

Theme development is a big topic and it's completely normal that you will encounter problems which might require you to reach out for help. In fact, we provide several knowledge and support platforms for theme development already:

* [Theme Development](https://shopify.dev/themes)

## Theme code principles

Before contributing to Workflow, please read the following theme code principles to better understand our fundamental approach to theme development. The expectation is that you follow these principles as you build for Workflow.
Before contributing to Helium, please read the following theme code principles to better understand our fundamental approach to theme development. The expectation is that you follow these principles as you build for Helium.

### Why these principles?

Expand Down Expand Up @@ -88,16 +88,17 @@ And since legacy browsers are often the slowest, we don’t burden them with pol

## Contributing code

You can follow these steps to go from setting up a store to creating a pull request for Workflow.
You can follow these steps to go from setting up a store to creating a pull request for helium.

>:information_source: We'll assume you're already set up with Git and GitHub (if you're not familiar with these, [start with these docs](https://docs.github.com/en/github/getting-started-with-github/quickstart/set-up-git)).
1. Set up a [development store](https://shopify.dev/themes/tools/development-stores) so you can test your code changes (assuming you don't already have a store).
2. Install the [Shopify CLI](https://github.com/shopify/shopify-cli) by following [these steps](https://shopify.dev/themes/tools/cli/installation).
3. Fork the repository, clone it and create a new branch:

```sh
git clone git@github.com:your-username/workflow.git
cd workflow
git clone git@github.com:your-username/helium.git
cd helium
git checkout -b your-new-branch-name
```
4. Launch a development server:
Expand All @@ -114,11 +115,10 @@ git commit -a -m="Your commit message"
git push origin your-new-branch-name
```
8. Open a pull request. See [GitHub's official documentation](https://help.github.com/articles/creating-a-pull-request-from-a-fork/) for more details.
9. Before you can merge your pull request, you must sign Shopify's [Contributor License Agreement (CLA)](https://cla.shopify.com/).

## Reporting a bug

Bugs are tracked as [GitHub issues](https://github.com/younessidbakkasse/workflow/issues). Search open issues to see if someone else has reported a similar bug. If it's something new, [open an issue](https://github.com/younessidbakkasse/workflow/issues/new). We'll use the issue to have a conversation about the problem you want to fix.
Bugs are tracked as [GitHub issues](https://github.com/idbakkasse/helium/issues). Search open issues to see if someone else has reported a similar bug. If it's something new, [open an issue](https://github.com/idbakkasse/helium/issues/new). We'll use the issue to have a conversation about the problem you want to fix.

When creating a new issue, please ensure the issue is clear and include additional details to help maintainers reproduce it:

Expand All @@ -131,7 +131,7 @@ When creating a new issue, please ensure the issue is clear and include addition

## Reviewing

We (the Themes team) review every single PR. The purpose of reviews is to create the best version of Workflow we can for merchants, developers, and others who use it.
We (the Themes team) review every single PR. The purpose of reviews is to create the best version of Helium we can for merchants, developers, and others who use it.

:yellow_heart: Reviews are always respectful, acknowledging that everyone did the best possible job with the knowledge they had at the time.
:yellow_heart: Reviews discuss content, not the person who created it.
Expand All @@ -147,10 +147,6 @@ For code changes, make sure that you:
- [ ] If there are any failing checks in your PR, troubleshoot them until they're all passing.
- [ ] Add @username/themes-front-end-developers as a reviewer.

### Pull request template

When you open a pull request, you must fill out the "Ready for review" template before we can review your PR. This template helps reviewers understand your changes and the purpose of your pull request.

### Suggested changes

We may ask for changes to be made before a PR can be merged, either using [suggested changes](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/incorporating-feedback-in-your-pull-request) or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
Expand Down
27 changes: 24 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@
> This was made as a follow-up to the Shopify Unite 2021 event revealing the new theme online store 2.0 that has supports for JSON templates and section everywhere concept and few other features.
[![Shopify Theme Check][theme-check-badge]][theme-check-url]
[![Downloads][npm-downloads-badge]][npm-downloads-url]
[![Discord][discord-badge]][discord-url]
[![Twitter][twitter-badge]][twitter-url]
[![ETH][eth-badge]][eth-url]
[![SOL][sol-badge]][sol-url]

## Quick started

Expand All @@ -16,6 +21,7 @@ shopify theme init -u https://github.com/idbakkasse/helium.git
> Pro tip: click the `Use this template` button above to start from a fresh repositry.
Then lunch the development server on `localhost:9292` using NPM/Yarn
The command will also run Helium's watch mode on files.

```shell
npm run serve
Expand Down Expand Up @@ -45,9 +51,24 @@ Everyone is welcome to make Shopify theme development better! Please read the [C

## License

Copyright (c) 2022 Youness Idbakkasse. See [LICENSE](.github/LICENSE) for further details.
MIT License Copyright (c) 2022 Youness Idbakkasse. See [LICENSE](.github/LICENSE) for further details.

<!-- Badges and links -->
[theme-check-badge]: https://github.com/younessidbakkasse/workflow/actions/workflows/check.yml/badge.svg

[theme-check-badge]: https://img.shields.io/github/workflow/status/idbakkasse/helium/Shopify%20Theme%20Check?style=flat-square&colorA=260400&colorB=FCFCFC
[theme-check-url]: https://github.com/younessidbakkasse/helium/actions/workflows/check.yml

[npm-downloads-badge]: https://img.shields.io/npm/dt/@idbakkasse/helium?style=flat-square&colorA=260400&colorB=FCFCFC
[npm-downloads-url]: https://npmjs.com/package/@idbakkasse/helium

<!-- Badges and links for branding -->
[twitter-badge]: https://img.shields.io/twitter/follow/iidbakkasse?label=Twitter&style=flat-square&colorA=260400&colorB=FCFCFC&logo=twitter&logoColor=FCFCFC
[twitter-url]: https://twitter.com/iidbakkasse

[discord-badge]: https://img.shields.io/discord/928403077818638397?style=flat-square&colorA=260400&label=discord&colorB=FCFCFC&logo=discord&logoColor=FCFCFC
[discord-url]: https://discord.gg/zhnBNXhxes

[eth-badge]: https://img.shields.io/badge/ETH-f5f5f5?style=flat-square&colorA=260400&colorB=260400
[eth-url]: https://blockchain.com/eth/address/0xC7e149f2c455a1C72AB320f27bC05Bc01AF6d439

[sol-badge]: https://img.shields.io/badge/SOL-f5f5f5?style=flat-square&colorA=260400&colorB=260400
[sol-url]: https://blockchain.com/sol/address/4DBq6KZ89j1zfjrgVa8qS1113DQZzFLhkdMVUj2aBojZ
5 changes: 0 additions & 5 deletions layout/theme.liquid
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@

<link rel="preload" href="{{ 'base.css' | asset_url }}" as="style">
<link rel="preload" href="{{ 'base.js' | asset_url }}" as="script">
<link rel="preload" href="{{ 'vendors.js' | asset_url }}" as="script">

{%- liquid
render 'head-seo'
Expand All @@ -31,10 +30,6 @@
{{ 'base.css' | asset_url | stylesheet_tag }}
<script src="{{- 'base.js' | asset_url -}}" defer="defer"></script>

<!-- Start vendor third party libaries -->
<script src="{{- 'vendors.js' | asset_url -}}" defer="defer"></script>
<!-- End vendor third party libaries -->

<!-- Header hook for plugins -->
{{ content_for_header }}
</head>
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
"lint": "helium lint"
},
"devDependencies": {
"@idbakkasse/helium": "^0.1.2"
"@idbakkasse/helium": "^0.1.3"
},
"dependencies": {},
"engines": {
Expand Down

0 comments on commit 85cb3bb

Please sign in to comment.