chore: add section about chatgpt integration to README & ToC

This commit is contained in:
Bart Stefanski 2023-04-21 17:21:51 +02:00 • committed by GitHub
parent d469953f28
commit 40db2b1e97
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -31,6 +31,20 @@ With this template, you get all the awesomeness you need:
- 💯 **Perfect Lighthouse score** - Because performance matters - 💯 **Perfect Lighthouse score** - Because performance matters
- 🚢 **[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog - 🚢 **[Semantic Release](https://github.com/semantic-release/semantic-release)** - for automatic changelog
## Table of Contents
- [Features](#-features)
- [Getting Started](#-getting-started)
- [Deployment](#-deployment)
- [Scripts Overview](#-scripts-overview)
- [Coupling Graph](#-coupling-graph)
- [Testing](#-testing)
- [Styling and Design System](#-styling-and-design-system)
- [State Management](#-state-management)
- [ChatGPT Code Review](#-chatgpt-code-review)
- [Contribution](#-contribution)
- [License](#-license)
## 🎯 Getting Started ## 🎯 Getting Started
To get started with this boilerplate, follow these steps: To get started with this boilerplate, follow these steps:
@ -185,6 +199,12 @@ While this boilerplate doesn't include a specific state management library, we b
Choose the library that best fits your requirements and project structure to ensure an efficient state management solution for your application. Choose the library that best fits your requirements and project structure to ensure an efficient state management solution for your application.
## 🤖 ChatGPT Code Review
We've integrated the innovative [ChatGPT Code Review](https://github.com/anc95/ChatGPT-CodeReview) for AI-powered, automated code reviews. This feature provides real-time feedback on your code, helping improve code quality and catch potential issues.
To use ChatGPT Code Review, add an `OPENAI_API_KEY` environment variable with an appropriate key from the OpenAI platform. For setup details, refer to the [Using GitHub Actions](https://github.com/anc95/ChatGPT-CodeReview#using-github-actions) section in the documentation.
## 🤝 Contribution ## 🤝 Contribution
Contributions are always welcome! To contribute, please follow these steps: Contributions are always welcome! To contribute, please follow these steps: