docs: remove conventional commits section from README
This commit is contained in:
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! 🎉**
|
||||
|
Reference in New Issue
Block a user