Skip to content

Commit

Permalink
chore
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-yin committed Apr 25, 2024
1 parent 96422e1 commit f358e9f
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 0 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Change Log

## v1.0.3

1. Remove `Bootstrap` from the default setup.
2. Update doc about `Bootstrap`, `SWC`, `React`, `Vue`
6. Update frontend dependency to the latest version

## v1.0.2

1. Support Node LTS Iron
Expand Down
1 change: 1 addition & 0 deletions docs/CHANGELOG.md
23 changes: 23 additions & 0 deletions docs/linting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Code Linting

Code linting on the frontend can guarantee the code quality and make the code more readable.

We use `eslint` and `stylelint` to lint the code, and you can just use them out of the box.

## ESLint

ESLint is a static code analysis tool for identifying problematic patterns found in JavaScript code. It helps maintain code quality by enforcing coding standards and best practices. Some benefits of using ESLint include:

- **Code Consistency:** ESLint ensures that all code in the project follows the same style and guidelines, making it easier for developers to collaborate.
- **Error Prevention:** It helps catch common programming errors and potential bugs during development.
- **Customizable Rules:** ESLint allows you to configure rules based on your project's specific requirements.
- **Integration:** ESLint can be easily integrated into various build tools and IDEs.

## Stylelint

Stylelint is a linting tool for CSS and SCSS that helps maintain consistent coding styles and prevents errors in your stylesheets. Some benefits of using Stylelint include:

- **Consistent Styles:** Stylelint enforces consistent coding styles across your stylesheets, ensuring a uniform look and feel.
- **Error Detection:** It helps identify errors and potential issues in your CSS code.
- **Customizable Configuration:** Stylelint allows you to configure rules and plugins to suit your project's needs.
- **Integration:** Stylelint can be seamlessly integrated into your build process and editor.
2 changes: 2 additions & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ nav:
- Setup With Django: setup_with_django.md
- Setup With Flask: setup_with_flask.md
- Frontend workflow: frontend.md
- Code Linting: linting.md
- Live Reload: live_reload.md
- Tailwind CSS: setup_with_tailwind.md
- Bootstrap: setup_with_bootstrap.md
Expand All @@ -28,3 +29,4 @@ nav:
- Typescript: typescript.md
- Deployment Notes: deployment.md
- Run NPM command at root directory: run_npm_command_at_root.md
- Change Log: CHANGELOG.md

0 comments on commit f358e9f

Please sign in to comment.