Merge pull request 'docs: remove conventional commits section from README' (#1) from task/update-template into main
Reviewed-on: #1
This commit is contained in:
@ -9,6 +9,7 @@ on:
|
||||
jobs:
|
||||
lint-and-test:
|
||||
name: Lint, Test & Build
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
@ -45,6 +46,7 @@ jobs:
|
||||
|
||||
security-audit:
|
||||
name: Security Audit
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
|
20
README.md
20
README.md
@ -12,7 +12,6 @@ A comprehensive, production-ready Next.js template featuring modern development
|
||||
- **Husky** for Git hooks
|
||||
- **lint-staged** for pre-commit checks
|
||||
- **Jest** and **React Testing Library** for testing
|
||||
- **Commitizen** for conventional commits
|
||||
- **Gitea Actions** CI/CD pipeline
|
||||
|
||||
## 📁 Project Structure
|
||||
@ -64,6 +63,7 @@ A comprehensive, production-ready Next.js template featuring modern development
|
||||
```
|
||||
|
||||
4. **Start the development server:**
|
||||
|
||||
```bash
|
||||
bun run dev
|
||||
```
|
||||
@ -151,18 +151,6 @@ The Gitea Actions workflow includes:
|
||||
- **Prettier**: Ensures consistent formatting
|
||||
- **Type checking**: Validates TypeScript
|
||||
|
||||
### Conventional Commits
|
||||
|
||||
Use `bun run commit` to create conventional commits:
|
||||
|
||||
- `feat`: New features
|
||||
- `fix`: Bug fixes
|
||||
- `docs`: Documentation changes
|
||||
- `style`: Code style changes
|
||||
- `refactor`: Code refactoring
|
||||
- `test`: Test changes
|
||||
- `chore`: Maintenance tasks
|
||||
|
||||
### Coverage Requirements
|
||||
|
||||
- Minimum 70% coverage for branches, functions, lines, and statements
|
||||
@ -201,10 +189,6 @@ DATABASE_URL=your-database-url
|
||||
6. Push to the branch: `git push origin feature/new-feature`
|
||||
7. Submit a pull request
|
||||
|
||||
## 📄 License
|
||||
|
||||
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
## 🔗 Links
|
||||
|
||||
- [Next.js Documentation](https://nextjs.org/docs)
|
||||
@ -217,4 +201,4 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
|
||||
|
||||
---
|
||||
|
||||
**Happy coding! 🎉**
|
||||
## **Happy coding! 🎉**
|
||||
|
13
package.json
13
package.json
@ -14,11 +14,7 @@
|
||||
"test": "jest",
|
||||
"test:watch": "jest --watch",
|
||||
"test:ci": "jest --ci --coverage --watchAll=false",
|
||||
"prepare": "husky",
|
||||
"commit": "cz",
|
||||
"install": "bun install",
|
||||
"add": "bun add",
|
||||
"remove": "bun remove"
|
||||
"prepare": "husky"
|
||||
},
|
||||
"dependencies": {
|
||||
"react": "^19.0.0",
|
||||
@ -39,8 +35,6 @@
|
||||
"@typescript-eslint/eslint-plugin": "^8.32.1",
|
||||
"@typescript-eslint/parser": "^8.32.1",
|
||||
"audit-ci": "^7.1.0",
|
||||
"commitizen": "^4.3.0",
|
||||
"cz-conventional-changelog": "^3.3.0",
|
||||
"eslint": "^9",
|
||||
"eslint-config-next": "15.3.2",
|
||||
"eslint-config-prettier": "^9.1.0",
|
||||
@ -59,11 +53,6 @@
|
||||
"tailwindcss": "^4",
|
||||
"typescript": "^5"
|
||||
},
|
||||
"config": {
|
||||
"commitizen": {
|
||||
"path": "./node_modules/cz-conventional-changelog"
|
||||
}
|
||||
},
|
||||
"lint-staged": {
|
||||
"**/*.{js,jsx,ts,tsx}": [
|
||||
"eslint --fix",
|
||||
|
Reference in New Issue
Block a user