Skip to content

Commit ef8bb65

Browse files
docs: updates pull request template and updates contributing file (#2587)
## What's the purpose of this pull request? - removes `pull_request_template.md` from `packages/core` since we are not using it - updates `PULL_REQUEST_TEMPLATE.md` and `CONTRIBUTING.MD` files --------- Co-authored-by: Larícia Mota <[email protected]>
1 parent d298777 commit ef8bb65

File tree

4 files changed

+13
-47
lines changed

4 files changed

+13
-47
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -38,3 +38,8 @@
3838
**Dependencies**
3939

4040
- [ ] Committed the `yarn.lock` file when there were changes to the packages
41+
42+
**Documentation**
43+
44+
- [ ] PR description
45+
- [ ] For documentation changes, ping `@Mariana-Caetano` to review and update (Or submit a doc request)

CONTRIBUTING.MD

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,8 +81,8 @@ After committing your changes, push them to the remote repository and open a Pul
8181

8282
1. Please add a clear and concise title PR title with one of the prefixes.
8383

84-
- Available prefixes: `Feat`, `Fix`, `Chore`, `Docs`, `Style`
85-
- Example: `Feat: Add Carousel component`
84+
- Available prefixes: `feat`, `fix`, `chore`, `docs`, `style`, `refactor`, `ci` and `test`
85+
- Example: `feat: Add Carousel component`
8686

8787
2. You will be presented with a pull request template. Please describe the motivation behind your changes and provide details about what you have implemented.
8888

packages/core/README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@ This starter ships the main FastStore configuration files to get your store up a
1616

1717
> PS: you can install dependencies using the package manager of your choosing. In this guide, we'll be using `yarn` as an example.
1818
19-
Install dependencies with yarn
19+
Install dependencies with yarn
2020

21-
```shell
22-
yarn
23-
```
21+
```shell
22+
yarn
23+
```
2424

2525
2. **Start developing**
2626

@@ -67,7 +67,6 @@ A quick look at the top-level files and directories you'll see in a this NextJS
6767
├── tsconfig.json
6868
├── postcss.config.js
6969
├── postinstall.js
70-
├── pull_request_template.md
7170
├── README.md
7271
├── stylelint.config.js
7372
├── tsconfig.json
@@ -97,11 +96,9 @@ A quick look at the top-level files and directories you'll see in a this NextJS
9796

9897
12. **`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
9998

100-
13. **`pull_request_template.md`**: Template used when creating your Pull Requests
101-
102-
14. **`.prettierignore`**: Ignore listed files when applying prettier rules
99+
13. **`.prettierignore`**: Ignore listed files when applying prettier rules
103100

104-
15. **`.eslintignore`**: Ignore listed files when applying eslint rules
101+
14. **`.eslintignore`**: Ignore listed files when applying eslint rules
105102

106103
## 💻 Code Structure
107104

packages/core/pull_request_template.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

0 commit comments

Comments
 (0)