Skip to content
This repository has been archived by the owner on Jun 2, 2022. It is now read-only.

[FSSS-178] Adds Changelog file #296

Merged
merged 5 commits into from
Feb 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Changelog

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

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

### Changed

### Deprecated

### Removed

### Fixed

### Security

## [0.1.0] - 2022-02-01

Version released for the Closed Beta

### Added

- This changelog
33 changes: 21 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,12 @@ As of Dec, 22, 2021, this starter is still far from covering most basic cases fo

Open the `awesome.store` directory in your code editor of choice and edit `src/pages/index.tsx`. Save your changes and the browser will update in real-time!

## :technologist: Contributing

1. **Keep the CHANGELOG updated**
We use a CHANGELOG to keep the history of all notable changes made to this repository.
Each PR must have at least one entry on the `[UNRELEASED]` section of the `CHANGELOG.md` file.

## 🧐 What's inside?

A quick look at the top-level files and directories you'll see in a Gatsby project.
Expand All @@ -98,6 +104,7 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje
├── tsconfig.json
├── store.config.js
├── README.md
├── CHANGELOG.md
├── __generated__
├── babel.config.js
├── cypress
Expand Down Expand Up @@ -135,27 +142,29 @@ A quick look at the top-level files and directories you'll see in a Gatsby proje

13. **`README.md`**: A text file containing useful reference information about your project.

14. **`__generated__`**: Where TypeScript typings are generated for your GraphQL queries. You can use these files for strongly typing your App
14. **`CHANGELOG.md`**: A text file containing all notable changes to the project.

15. **`__generated__`**: Where TypeScript typings are generated for your GraphQL queries. You can use these files for strongly typing your App

15. **`babel.config.js`**: [Babel configurations](https://babeljs.io/docs/en/configuration#babelrcjson) for you app. This is where you can change the targeted browsers.
16. **`babel.config.js`**: [Babel configurations](https://babeljs.io/docs/en/configuration#babelrcjson) for you app. This is where you can change the targeted browsers.

16. **`cypress`**: End to End(e2e) tests using Cypress. Most of the scenarios are covered here. Add your custom flows to avoid regressions
17. **`cypress`**: End to End(e2e) tests using Cypress. Most of the scenarios are covered here. Add your custom flows to avoid regressions

17. **`cypress.json`**: [Cypress configuration file](https://docs.cypress.io/guides/references/configuration)
18. **`cypress.json`**: [Cypress configuration file](https://docs.cypress.io/guides/references/configuration)

18. **`gatsby-browser.js`**: Lets you respond to Gatsby-specific events within the browser, and wrap your page components in additional global components. The Gatsby Browser API gives you many options for interacting with the client-side of Gatsby. More info at: https://www.gatsbyjs.com/docs/reference/config-files/gatsby-browser/
19. **`gatsby-browser.js`**: Lets you respond to Gatsby-specific events within the browser, and wrap your page components in additional global components. The Gatsby Browser API gives you many options for interacting with the client-side of Gatsby. More info at: https://www.gatsbyjs.com/docs/reference/config-files/gatsby-browser/

19. **`gatsby-ssr.js`**: Lets you respond to Gatsby-specific events during SSG and SSR, and wrap your page components in additional global components. More info at: https://www.gatsbyjs.com/docs/reference/config-files/gatsby-ssr/
20. **`gatsby-ssr.js`**: Lets you respond to Gatsby-specific events during SSG and SSR, and wrap your page components in additional global components. More info at: https://www.gatsbyjs.com/docs/reference/config-files/gatsby-ssr/

20. **`lighthouserc.js`**: Configures [Google Lighthouse CI](https://github.com/GoogleChrome/lighthouse-ci). This is where you can turn on/off lighthouse assertions to be used by Lighthouse CI Bot/hook
21. **`lighthouserc.js`**: Configures [Google Lighthouse CI](https://github.com/GoogleChrome/lighthouse-ci). This is where you can turn on/off lighthouse assertions to be used by Lighthouse CI Bot/hook

21. **`pull_request_template.md`**: Template used when creating your Pull Requests
22. **`pull_request_template.md`**: Template used when creating your Pull Requests

22. **`renovate.json`**: Renovate configuration file to keep your store always fresh with Faststore's latest versions
23. **`renovate.json`**: Renovate configuration file to keep your store always fresh with Faststore's latest versions

23. **`.prettierignore`**: Ignore listed files when applying prettier rules
24. **`.prettierignore`**: Ignore listed files when applying prettier rules

24. **`.eslintignore`**: Ignore listed files when applying eslint rules
25. **`.eslintignore`**: Ignore listed files when applying eslint rules

## 💻 Code Structure

Expand Down Expand Up @@ -333,7 +342,7 @@ The aforementioned guide works well for UI components. However, components like

## 🖊️ Styling Components

Our customized theme is based on [Design Tokens](https://css-tricks.com/what-are-design-tokens/) using [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/--*) or a CSS class for each token. Today, we have the following files in the `src/styles` folder:
Our customized themes are based on [Design Tokens](https://css-tricks.com/what-are-design-tokens/) using [CSS Variables](https://developer.mozilla.org/en-US/docs/Web/CSS/--*) or a CSS class for each token. Today, we have the following files in the `src/styles` folder:

### `theme.scss`

Expand Down
19 changes: 14 additions & 5 deletions pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@

## What's the purpose of this pull request?

<em>Considering the context, what is the problem we'll solve? Where in VTEX's big picture our issue fits in? Write a tweet about the context and the problem itself.</em>

## How it works?
## How does it work?

<em>Tell us the role of the new feature, or component, in its context.</em>

## How to test it?
<em>Describe the steps with bullet points. Is there any external reference, link, or example?</em>

<em>Describe the steps with bullet points. Is there any external reference, link, or example?</em>

## References
<em>Spread the knowledge: is this any content you used to create this PR that is worth sharing?</em>

<em>Extra tip: add references to related issues or mention people important to this PR may be good for the documentation and reviewing process</em>
<em>Spread the knowledge: is this any content you used to create this PR that is worth sharing?</em>

<em>Extra tip: add references to related issues or mention people important to this PR may be good for the documentation and reviewing process</em>

## Checklist

<em>You may erase this after checking them all ;)</em>

- [] CHANGELOG entry added