GitHub Copilot Chat peut vous aider à créer des modèles à diverses fins, telles que la documentation project, les extraits de code ou le suivi des problèmes. En utilisant des modèles, vous pouvez simplifier votre flux de travail et assurer la cohérence entre vos projets.
Exemple de scénario
Vous souhaitez créer un modèle pour un fichier README project qui inclut des sections pour project description, des instructions d’installation, des exemples d’utilisation et des instructions de contribution. Vous pouvez demander à Tchat Copilot de générer un modèle de fichier README conformément aux meilleures pratiques et à vos exigences spécifiques. Vous pouvez ensuite utiliser ce modèle comme point de départ pour toutes vos project documentation.
Exemple d’invite
Create a README template for a new open-source project that includes sections for project description, installation instructions, usage examples, and contribution guidelines. Make it clear and easy to follow.
Create a README template for a new open-source project that includes sections for project description, installation instructions, usage examples, and contribution guidelines. Make it clear and easy to follow.
Exemple de réponse
Remarque
La réponse suivante est un exemple. Les réponses Tchat Copilot ne sont pas déterministes, vous pouvez donc obtenir une réponse différente de celle affichée ici.
Copilot vous fournira un modèle de fichier README structuré. Vous pouvez copier le modèle Tchat Copilot fournit et le personnaliser davantage pour répondre aux besoins de votre project.
# Project Name
> **Short description:**
> A brief summary of what your project does, its main features, and its purpose.
---
## Table of Contents
- [Description](#description)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
---
## Description
Provide a detailed explanation of what your project does, why it exists, and any important background information.
You may want to include:
- Key features
- Supported platforms or languages
- Screenshots or diagrams
---
## Installation
1. **Clone the repository**
```sh
git clone https://github.com/your-username/your-repo-name.git
cd your-repo-name
```
2. **Install dependencies**
```sh
# Example for Node.js projects
npm install
# Example for Python projects
pip install -r requirements.txt
```
3. **Additional setup**
- List any other required steps (e.g., environment variables, configuration files)
---
## Usage
Provide clear usage instructions and code examples.
```sh
# Example command
your-command --option value
```
```python
# Example in Python
import your_module
result = your_module.do_something()
print(result)
```
- Explain any CLI options, configuration, or parameters.
- Link to more detailed documentation if available.
---
## Contributing
Contributions are welcome! Please follow these guidelines:
1. **Fork the repository**
2. **Create a new branch**
```sh
git checkout -b feature/your-feature-name
```
3. **Make your changes**
4. **Test your changes**
5. **Commit and push**
```sh
git commit -m "Add feature: your-feature-name"
git push origin feature/your-feature-name
```
6. **Open a pull request**
**Code of Conduct:**
Please be respectful and follow our [Code of Conduct](CODE_OF_CONDUCT.md).
**Issues & Suggestions:**
Open an issue for bugs, questions, or feature requests.
---
## License
This project is licensed under the [INSERT LICENSE](link to relevant license information).
---
## Contact
- **Maintainer:** [Your Name](mailto:your@email.com)
- **Project Link:** https://github.com/your-username/your-repo-name
---