Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Development #30

Merged
merged 36 commits into from
Oct 13, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
26d81f5
Add mirageJS integration and mock placeholder data
joekotvas Oct 9, 2023
99bc9be
Disable eslint linebreak rule
Oct 9, 2023
6de1d1e
Merge pull request #24 from chingu-voyages/fix/disable-eslint-linebre…
timDeHof Oct 9, 2023
5ed675c
Put quotes around linebreak-style value
Oct 10, 2023
ee58285
chore(eslintrc.cjs): update eslint configuration
timDeHof Oct 11, 2023
c439f9e
Merge pull request #26 from chingu-voyages/fix/missing-quotes-in-esli…
timDeHof Oct 11, 2023
eb4aa3d
chore: Merge branch 'development' into feat/impromate-browser-router
timDeHof Oct 11, 2023
a9f3858
chore: draft branch of browser-router setup
timDeHof Oct 11, 2023
bff84b1
build(refactoring husky and commitlint install): improve the team com…
timDeHof Oct 11, 2023
018273c
chore(release): 0.0.0
timDeHof Oct 11, 2023
ddfcc28
build(add changelog.md): add a changelog for patches, minor, or major…
timDeHof Oct 11, 2023
8218915
chore: add lint-staged to run in husky
timDeHof Oct 11, 2023
0403e5f
chore: refactor husky hooks
timDeHof Oct 11, 2023
42e22fb
refactor(refactor the folder structure): refactored for scalability f…
timDeHof Oct 11, 2023
885a7c3
Merge pull request #28 from chingu-voyages/joekotvas-mirageJS
timDeHof Oct 11, 2023
8468fb9
chore(constants): add new recipe link to navLinks array
timDeHof Oct 11, 2023
b854b93
Merge branch 'development' into feat/impromate-browser-router
timDeHof Oct 11, 2023
3daa135
style(creating a styles folder): change name of 'index.css' to 'globa…
timDeHof Oct 11, 2023
d16a5a8
chore(release): 0.0.1
timDeHof Oct 11, 2023
4cb7a56
chore(release): 0.0.2
timDeHof Oct 11, 2023
16c0757
docs(development-workflow.md): update the "track changes" section to …
timDeHof Oct 12, 2023
5ef0c1e
perf(add path aliasing): adding path aliasing to vite config
timDeHof Oct 12, 2023
a1ac760
chore(release): 0.0.3
timDeHof Oct 12, 2023
3111ba6
chore(eslintrc.cjs): temp turning off "react/prop-types" rule
timDeHof Oct 12, 2023
04c23b5
fix(postcard.jsx): adds validation to the post
timDeHof Oct 12, 2023
509096a
perf(vite.config.js): removed tailwind-vite-plugin
timDeHof Oct 12, 2023
2a40a40
Update linebreak-style to default to unix
Oct 12, 2023
c986a0d
fix(public): add necessary files for netlify
timDeHof Oct 12, 2023
3fe648d
chore(release): 0.0.4
timDeHof Oct 12, 2023
4c31897
Merge pull request #29 from chingu-voyages/fix/update-eslint--linebre…
timDeHof Oct 12, 2023
025b62e
fix(vite.config.js): removed exlint as a plugin in vite.config.js
timDeHof Oct 12, 2023
0370189
Merge branch 'development' into feat/impromate-browser-router
timDeHof Oct 12, 2023
57e0fd4
fix(vite.config.js): a bug has occured when netlify's building site
timDeHof Oct 12, 2023
bc66f9b
chore(.eslintrc.cjs): fixing line ending issue between mac and windows
timDeHof Oct 12, 2023
21fd936
fix(package-lock.json): reinstalled node_modules and package-lock.json
timDeHof Oct 12, 2023
52d97da
Merge pull request #27 from chingu-voyages/feat/impromate-browser-router
timDeHof Oct 12, 2023
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
1 change: 1 addition & 0 deletions .commitlintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{ "extends": ["@commitlint/config-conventional"] }
41 changes: 26 additions & 15 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,13 @@
module.exports = {
root: true,
env: { browser: true, es2020: true },
env: { browser: true, es2020: true, node: true },
parserOptions: { ecmaVersion: "latest", sourceType: "module" },
ignorePatterns: [
"dist",
".eslintrc.cjs",
".pnpm-lock.yaml",
"node_modules/*",
],
extends: [
"eslint:recommended",
"plugin:react/recommended",
Expand All @@ -9,26 +16,30 @@ module.exports = {
"plugin:@tanstack/eslint-plugin-query/recommended",
"prettier",
],
ignorePatterns: ["dist", ".eslintrc.cjs", ".pnpm-lock.yaml"],
parserOptions: { ecmaVersion: "latest", sourceType: "module" },
settings: { react: { version: "18.2" } },
plugins: ["react-refresh", "prettier", "@tanstack/query"],
rules: {
"react-refresh/only-export-components": [
"warn",
{ allowConstantExport: true },
],
"prettier/prettier": "error",
"@tanstack/query/exhaustive-deps": "error",
"@tanstack/query/prefer-query-object-syntax": "error",
"@tanstack/query/stable-query-client": "error",
"react/prop-types": "off",
},
settings: { react: { version: "18.2" } },
overrides: [
{
files: ["*.yaml", "*.yml"],
plugins: ["yaml"],
extends: ["plugin:yaml/recommended"],
rules: {
"import/no-unresolved": "off",
"react/prop-types": "off",
"react-refresh/only-export-components": [
"warn",
{ allowConstantExport: true },
],
"no-unused-vars": "off",
"no-undef": "off",
"prettier/prettier": ["error", {}, { usePrettierrc: true }],
"@tanstack/query/exhaustive-deps": "error",
"@tanstack/query/prefer-query-object-syntax": "error",
"@tanstack/query/stable-query-client": "error",
"react/prop-types": "off",
"linebreak-style": 0,
"eslint linkebreak-style": [0, "error", "windows"],
},
},
],
};
1 change: 1 addition & 0 deletions .husky/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
_
4 changes: 4 additions & 0 deletions .husky/commit-msg
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"

npx --no-install commitlint --edit $1
6 changes: 3 additions & 3 deletions .husky/pre-commit
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/usr/bin/env sh
. "$(dirname -- "$0")/_/husky.sh"
#!/bin/sh
. "$(dirname "$0")/_/husky.sh"

npx lint-staged
npx lint-staged
2 changes: 2 additions & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Ignore artifacts:
build
coverage
.dist
changelog.md
# Ignore all chingu docs files:
/docs
/meetings
Expand Down
33 changes: 33 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Changelog

All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.

### [0.0.4](https://github.com/chingu-voyages/v46-tier2-team-19/compare/v0.0.3...v0.0.4) (2023-10-12)


### Bug Fixes

* **postcard.jsx:** adds validation to the post ([04c23b5](https://github.com/chingu-voyages/v46-tier2-team-19/commit/04c23b57dfdfdb7908ebb423dd5544a0935a9d14))
* **public:** add necessary files for netlify ([c986a0d](https://github.com/chingu-voyages/v46-tier2-team-19/commit/c986a0d5f5c53dfa01b2c0a9bba24cf60ccf733b))

### [0.0.3](https://github.com/chingu-voyages/v46-tier2-team-19/compare/v0.0.2...v0.0.3) (2023-10-12)

### [0.0.2](https://github.com/chingu-voyages/v46-tier2-team-19/compare/v0.0.1...v0.0.2) (2023-10-11)

### [0.0.1](https://github.com/chingu-voyages/v46-tier2-team-19/compare/v0.0.0...v0.0.1) (2023-10-11)

## 0.0.0 (2023-10-11)


### Features

* add App.css, index.css, and main.jsx files ([b556c13](https://github.com/chingu-voyages/v46-tier2-team-19/commit/b556c1371ce64f385c90d96f02a70c579f9de80c))
* add vite.svg, tailwind.config.js, and vite.config.js files ([42df5fb](https://github.com/chingu-voyages/v46-tier2-team-19/commit/42df5fb5e34c8bf00cd5978a71eb017d1112b928))
* **assets:** add React logo SVG file ([7b73330](https://github.com/chingu-voyages/v46-tier2-team-19/commit/7b733300d58222f13cb43f5eb21ad3b16ce919e4))
* **meeting-voyage_kickoff.docx:** add meeting-voyage_kickoff.docx ([71a3ad1](https://github.com/chingu-voyages/v46-tier2-team-19/commit/71a3ad14c2bc901e3171e44386b91865ffb46880))
* **playwright.yml:** add Playwright Tests workflow ([60fff2d](https://github.com/chingu-voyages/v46-tier2-team-19/commit/60fff2d9e5be552fa69833f0c367022244a85c11))


### Bug Fixes

* getting playwright workflow to work ([dda0812](https://github.com/chingu-voyages/v46-tier2-team-19/commit/dda08128911126fc42aa0e9a0d8af9fd7e33a5c9))
20 changes: 12 additions & 8 deletions docs/development-workflow.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Development workflow

1. **Ticket/Issue**
- Take a note of the issue number of the ticket you will word on.
- Take a note of the issue number of the ticket you will word on in Jira.
- If no ticket exists then create a new ticket and take a note
2. **Create a new branch** from development branch

Expand Down Expand Up @@ -30,31 +30,35 @@

3. **Track changes:** Try to do only the work required in the feature branch.
After you saved your work file(s):
- Use `git add .` or `git add <file name>` to add the new version of your
work file(s) to the staging area on your local directory.
- Use `git add .` or `git add <file name>` to add the new version of your work file(s) to the staging area on your local directory.
- Then use `git commit -am <message>` to commit your work.

or

- use `npm run cz` to commitLint to help you write your commits.
- when you have committed your work to github, use `npm run release:patch` to update the changelog.
- When you are ready to push your work to Github, use `git push`.
4. **Pull Request(PR):** When you have finished your work (issue/ticket), in
1. **Pull Request(PR):** When you have finished your work (issue/ticket), in
Github:

- Select the `Pull Requests` tab and select the `New pull request button`.
- Here you can select for your branch `<branch-name>` to be merged into the
development branch.
> **All PRs must be to the development branch**

5. **Add comment:** Inside your PR in the description section type
2. **Add comment:** Inside your PR in the description section type
`closes #<issue-number>` for example `closed #42`. Select the issue number
that you are working on from the dropdown. This will link the PR to the
ticket.
6. **Code review:** In the PR you create select someone from the team to review
3. **Code review:** In the PR you create select someone from the team to review
the PR. The PR will be reviewed by that person. They may request changes to
the code or they may approve for the PR to be merged.
> If changes are requested, refer to step 3 above.
>
> Please try to make the requested changes within 24 hours of the request
7. **Merged to development branch:** If approved either you or the reviewer may
4. **Merged to development branch:** If approved either you or the reviewer may
merge the PR.
8. Once merged you can work on another ticket.
5. Once merged you can work on another ticket.

> ### A couple of things to always ask yourself
>
Expand Down
12 changes: 12 additions & 0 deletions jsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@/*": ["src/*"],
"@/api": ["src/api"],
"@/pages/*": ["src/pages/*"],
"@/features/*": ["src/features/*"],
"@/constants": ["src/constants"]
}
}
}
Loading
Loading