You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
5
+
This repository contains the Copilot SDK, a set of multi-language SDKs (Node/TypeScript, Python, Go, .NET) for building applications with the GitHub Copilot agent, maintained by the GitHub Copilot team.
7
6
8
7
Contributions to this project are [released](https://help.github.com/articles/github-terms-of-service/#6-contributions-under-repository-license) to the public under the [project's open source license](LICENSE).
9
8
10
9
Please note that this project is released with a [Contributor Code of Conduct](CODE_OF_CONDUCT.md). By participating in this project you agree to abide by its terms.
11
10
12
-
## What kinds of contributions we're looking for
11
+
## Before You Submit a PR
13
12
14
-
We'd love your help with:
13
+
**Please discuss any feature work with us before writing code.**
15
14
16
-
* Fixing any bugs in the existing feature set
17
-
* Making the SDKs more idiomatic and nice to use for each supported language
18
-
* Improving documentation
15
+
The team already has a committed product roadmap, and features must be maintained in sync across all supported languages. Pull requests that introduce features not previously aligned with the team are unlikely to be accepted, regardless of their quality or scope.
19
16
20
-
If you have ideas for entirely new features, please post an issue or start a discussion. We're very open to new features but need to make sure they align with the direction of the underlying Copilot CLI and can be maintained in sync across all our supported languages.
17
+
If you submit a PR, **be sure to link to an associated issue describing the bug or agreed feature**. No PRs without context :)
21
18
22
-
Currently **we are not looking to add SDKs for other languages**. If you want to create a Copilot SDK for another language, we'd love to hear from you, and we may offer to link to your SDK from our repo. However we do not plan to add further language-specific SDKs to this repo in the short term, since we need to retain our maintenance capacity for moving forwards quickly with the existing language set. So, for any other languages, please consider running your own external project.
19
+
## What We're Looking For
23
20
24
-
## Prerequisites for running and testing code
21
+
We welcome:
22
+
23
+
- Bug fixes with clear reproduction steps
24
+
- Improvements to documentation
25
+
- Making the SDKs more idiomatic and nice to use for each supported language
26
+
- Bug reports and feature suggestions on [our issue tracker](https://github.com/github/copilot-sdk/issues) — especially for bugs with repro steps
27
+
28
+
We are generally **not** looking for:
29
+
30
+
- New features, capabilities, or UX changes that haven't been discussed and agreed with the team
31
+
- Refactors or architectural changes
32
+
- Integrations with external tools or services
33
+
- Additional documentation
34
+
-**SDKs for other languages** — if you want to create a Copilot SDK for another language, we'd love to hear from you and may offer to link to your SDK from our repo. However we do not plan to add further language-specific SDKs to this repo in the short term, since we need to retain our maintenance capacity for moving forwards quickly with the existing language set. For other languages, please consider running your own external project.
35
+
36
+
## Prerequisites for Running and Testing Code
25
37
26
38
This is a multi-language SDK repository. Install the tools for the SDK(s) you plan to work on:
27
39
28
40
### All SDKs
29
-
1. (Optional) Install [just](https://github.com/casey/just) command runner for convenience
41
+
42
+
1. The end-to-end tests across all languages use a shared test harness written in Node.js. Before running tests in any language, `cd test/harness && npm ci`.
0 commit comments