Templates/Next-Template-App-Router
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove conventional commits section from README

Browse Source
This commit is contained in:
Jan-Marlon Leibl
2025-05-27 12:46:22 +02:00
parent 9b7d001611
commit fdc22c957d
2 changed files with 3 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -12,7 +12,6 @@ A comprehensive, production-ready Next.js template featuring modern development
- **Husky** for Git hooks - **Husky** for Git hooks
- **lint-staged** for pre-commit checks - **lint-staged** for pre-commit checks
- **Jest** and **React Testing Library** for testing - **Jest** and **React Testing Library** for testing
- **Commitizen** for conventional commits
- **Gitea Actions** CI/CD pipeline - **Gitea Actions** CI/CD pipeline
## 📁 Project Structure ## 📁 Project Structure
@ -64,6 +63,7 @@ A comprehensive, production-ready Next.js template featuring modern development
``` ```
4. **Start the development server:** 4. **Start the development server:**
```bash ```bash
bun run dev bun run dev
``` ```
@ -151,18 +151,6 @@ The Gitea Actions workflow includes:
- **Prettier**: Ensures consistent formatting - **Prettier**: Ensures consistent formatting
- **Type checking**: Validates TypeScript - **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 ### Coverage Requirements
- Minimum 70% coverage for branches, functions, lines, and statements - 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` 6. Push to the branch: `git push origin feature/new-feature`
7. Submit a pull request 7. Submit a pull request
## 📄 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## 🔗 Links ## 🔗 Links
- [Next.js Documentation](https://nextjs.org/docs) - [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
View File

@ -14,11 +14,7 @@
"test": "jest", "test": "jest",
"test:watch": "jest --watch", "test:watch": "jest --watch",
"test:ci": "jest --ci --coverage --watchAll=false", "test:ci": "jest --ci --coverage --watchAll=false",
"prepare": "husky", "prepare": "husky"
"commit": "cz",
"install": "bun install",
"add": "bun add",
"remove": "bun remove"
}, },
"dependencies": { "dependencies": {
"react": "^19.0.0", "react": "^19.0.0",
@ -39,8 +35,6 @@
"@typescript-eslint/eslint-plugin": "^8.32.1", "@typescript-eslint/eslint-plugin": "^8.32.1",
"@typescript-eslint/parser": "^8.32.1", "@typescript-eslint/parser": "^8.32.1",
"audit-ci": "^7.1.0", "audit-ci": "^7.1.0",
"commitizen": "^4.3.0",
"cz-conventional-changelog": "^3.3.0",
"eslint": "^9", "eslint": "^9",
"eslint-config-next": "15.3.2", "eslint-config-next": "15.3.2",
"eslint-config-prettier": "^9.1.0", "eslint-config-prettier": "^9.1.0",
@ -59,11 +53,6 @@
"tailwindcss": "^4", "tailwindcss": "^4",
"typescript": "^5" "typescript": "^5"
}, },
"config": {
"commitizen": {
"path": "./node_modules/cz-conventional-changelog"
}
},
"lint-staged": { "lint-staged": {
"**/*.{js,jsx,ts,tsx}": [ "**/*.{js,jsx,ts,tsx}": [
"eslint --fix", "eslint --fix",