The goal of the GitHub Copilot Patterns and Excersises Working Group is to collect, document, and publish best practices for GitHub Copilot Patterns & Exercises. To make them easy to understand, evaluate, and apply, we encode them in a specific structure.
We welcome your participation, whether you make small or large contributions, for this working group to actively operate.
Please consider contributing to GitHub Copilot Patterns & Exercises. Below are suggestions on how you can contribute.
- Share opinions and encourage discussion: Fresh perspectives, interesting thoughts, or early novel ideas can provoke discussions and produce unpredictable outcomes. Please create Issues to share your opinions on GitHub Copilot Patterns & Exercises-related topics anytime.
- Read existing patterns and improve them: We recommend starting by reading the existing patterns and materials in this repository. Did you find a confusing phrase or poor grammar? A content error? Create a GitHub Issue or propose a correction directly as a pull request.
- Verify the use of patterns: Confirming that multiple organizations are using a pattern increases its relevance and informs other adopters that the pattern is proven. If you are using any of the published patterns, list your organization as a known instance of that pattern and describe your experience in applying it.
- Translate existing patterns: When introducing GitHub Copilot Patterns & Exercises practices in your region, the language barrier can be an issue for people, as most GitHub Copilot Patterns & Exercises content is available in English. Therefore, it is highly valuable to help people in your region/organization understand GitHub Copilot Patterns & Exercises in their language. For guidance on translating patterns into other languages, please refer to the translation instructions.
- Review open pull requests: Even if you don't know all the details of the Patterns Working Group, feedback on existing pull requests (especially those proposing changes to pattern content) is beneficial for their authors. As someone learning GitHub Copilot Patterns & Exercises, you can offer your opinion from the perspective of a future reader. As someone with your own GitHub Copilot Patterns & Exercises experience, you can share your experiences with the author.
- Contribute to new patterns: A major contribution you can make is documenting the best practices of GitHub Copilot Patterns & Exercises you have experienced or know about. This repository's content has defined maturity levels. First-time contributors should aim for Maturity Level 1: Initial (unstructured experience reports or patterns with missing parts) and 2: Structured (best practices following the pattern format and basic textual representation rules).
- Become a pattern advocate: By bringing in more people with their perspectives and experiences, patterns become better, and more topics get covered. Has a colleague told you about a novel GitHub Copilot Patterns & Exercises best practice? Invite them to contribute to this repository!
Please feel free to contact us for support in contributing to GitHub Copilot Patterns & Exercises, or just to chat. The easiest way to reach us is via Discord.
The contents of this repository are licensed under CC-BY-SA-4.0. By contributing to this repository, you grant us (and everyone else) the right to use your contribution under that license.
If you list yourself as the author of a pattern, we assume that you have granted permission to be mentioned when referencing that pattern.
While there is not yet a fully formalized code of conduct, we expect all contributors to treat each other with respect and help keep this community free from harassment and discrimination.