Changes for OSS

josebalius · web-flow · commit 0e25fc75a1c2 · 2026-03-09T07:45:00.000-07:00
diff --git a/.gitignore b/.gitignore
@@ -3,3 +3,4 @@ dist/
 pkg/
 *.tsbuildinfo
 bin/gofumpt
+cli/engine-cli
diff --git a/CODEOWNERS b/CODEOWNERS
@@ -0,0 +1,2 @@
+# This repository is maintained by:
+* @github/coding-agent-core-team
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opensource@github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,52 @@
+## Contributing
+
+Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
+
+Contributions to this project are released to the public under the project's open source license.
+
+Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
+
+## Development setup
+
+This repository contains a TypeScript SDK and a Go CLI for local engine testing.
+
+### Prerequisites
+
+- Node.js 20+
+- npm
+- Go (for working on the CLI in `cli/`)
+
+### Install dependencies
+
+```bash
+npm install
+```
+
+## Building and testing
+
+Run the existing build commands before submitting a pull request:
+
+```bash
+npm run build
+cd cli && go build ./cmd/engine-cli
+```
+
+If you change the SDK and use it from a linked local engine checkout, rebuild the SDK after your changes:
+
+```bash
+npm run build
+```
+
+## Submitting a pull request
+
+1. Fork the repository and clone your fork.
+2. Create a new branch for your change.
+3. Make your change and keep it focused.
+4. Run the relevant build and test commands locally.
+5. Open a pull request with a clear description of the problem and solution.
+
+## Resources
+
+- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
+- [Using Pull Requests](https://docs.github.com/pull-requests)
+- [GitHub Docs](https://docs.github.com)
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) GitHub, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -18,7 +18,7 @@ The Copilot Engine SDK provides everything you need to build an engine that runs
 
 ## Installation
 
-This package is hosted as a private GitHub repository. Add it to your `package.json`:
+Until this package is published to a package registry, install it directly from GitHub:
 
 ```json
 {
@@ -28,7 +28,7 @@ This package is hosted as a private GitHub repository. Add it to your `package.j
 }
 ```
 
-Then run `npm install`. Git credentials must be available for private repo access (e.g., `GITHUB_TOKEN`, SSH keys, or git credential helper).
+Then run `npm install`.
 
 ### Local Development
 
@@ -244,6 +244,18 @@ Engines receive these environment variables from the platform:
 - **[Integration Guide](docs/integration-guide.md)** — step-by-step guide to building an engine from scratch
 - **[Example Engine](https://github.com/github/agent-platform-engine-example)** — reference implementation
 
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for local setup, build commands, and pull request guidance.
+
+## Support
+
+See [SUPPORT.md](SUPPORT.md) for how to ask questions or report bugs.
+
+## Security
+
+See [SECURITY.md](SECURITY.md) for how to report security vulnerabilities.
+
 ## License
 
-MIT
+See [LICENSE](LICENSE).
diff --git a/SECURITY.md b/SECURITY.md
@@ -0,0 +1,30 @@
+Thanks for helping make GitHub safe for everyone.
+
+# Security
+
+GitHub takes the security of our software products and services seriously, including all of the open source code repositories managed through our GitHub organizations.
+
+Even though open source repositories are outside of the scope of our bug bounty program and therefore not eligible for bounty rewards, we will ensure that your finding gets passed along to the appropriate maintainers for remediation.
+
+## Reporting Security Issues
+
+If you believe you have found a security vulnerability in this repository, please report it to us through coordinated disclosure.
+
+**Please do not report security vulnerabilities through public GitHub issues, discussions, or pull requests.**
+
+Instead, please send an email to opensource-security@github.com.
+
+Please include as much of the information below as you can to help us better understand and resolve the issue:
+
+- The type of issue (for example, buffer overflow, SQL injection, or cross-site scripting)
+- Full paths of source file(s) related to the issue
+- The location of the affected source code (tag, branch, commit, or direct URL)
+- Any special configuration required to reproduce the issue
+- Step-by-step instructions to reproduce the issue
+- Proof-of-concept or exploit code, if possible
+- The impact of the issue, including how an attacker might exploit it
+
+## Policy
+
+See GitHub's Safe Harbor Policy:
+https://docs.github.com/en/site-policy/security-policies/github-bug-bounty-program-legal-safe-harbor#1-safe-harbor-terms
diff --git a/SUPPORT.md b/SUPPORT.md
@@ -0,0 +1,13 @@
+# Support
+
+## How to file issues and get help
+
+This project uses GitHub issues to track bugs and feature requests. Please search the existing issues before filing a new issue to avoid duplicates.
+
+If you have questions about using the Copilot Engine SDK, open an issue in this repository with enough detail for maintainers to reproduce the problem or understand the request.
+
+`copilot-engine-sdk` is under active development and maintained by GitHub staff. We will do our best to respond to support requests, feature requests, and community questions in a timely manner.
+
+## GitHub Support Policy
+
+Support for this project is limited to the resources listed above.
diff --git a/cli/engine-cli b/cli/engine-cli
diff --git a/docs/integration-guide.md b/docs/integration-guide.md
@@ -102,14 +102,16 @@ The **first thing your engine should do** is fetch the job details. This call re
 ### Using the SDK
 
 ```typescript
-import { fetchJobDetails } from "@github/copilot-engine-sdk";
+import { PlatformClient } from "@github/copilot-engine-sdk";
 
-const job = await fetchJobDetails(
-  process.env.GITHUB_PLATFORM_API_URL,
-  process.env.GITHUB_JOB_ID,
-  process.env.GITHUB_PLATFORM_API_TOKEN,
-  process.env.GITHUB_JOB_NONCE,
-);
+const platform = new PlatformClient({
+  apiUrl: process.env.GITHUB_PLATFORM_API_URL!,
+  jobId: process.env.GITHUB_JOB_ID!,
+  token: process.env.GITHUB_PLATFORM_API_TOKEN!,
+  nonce: process.env.GITHUB_JOB_NONCE,
+});
+
+const job = await platform.fetchJobDetails();
 ```
 
 ### Calling the API Directly
@@ -449,7 +451,7 @@ When called, it sends a `comment_reply` event to the platform, which posts a rep
 
 ### User-Provided MCP Servers
 
-Users can configure their own MCP servers (e.g., internal code search, documentation tools, database access) through the platform. These servers are **started by the platform before your engine is launched** and run outside the firewall so they have unrestricted network access.
+Users can configure their own MCP servers (for example, code search, documentation tools, or database access) through the platform. These servers are **started by the platform before your engine is launched** and run outside the firewall so they have unrestricted network access.
 
 The job response includes an `mcp_proxy_url` field when user MCP servers are configured. The proxy is an HTTP server that bridges your engine to the user's MCP servers. Your engine discovers available servers from the proxy and connects to them as HTTP MCP endpoints.
 
@@ -823,7 +825,7 @@ flowchart LR
 ```
 
 ```typescript
-import { PlatformClient, cloneRepo, finalizeChanges, fetchJobDetails } from "@github/copilot-engine-sdk";
+import { PlatformClient, cloneRepo, finalizeChanges } from "@github/copilot-engine-sdk";
 import { CopilotClient } from "@github/copilot-sdk";
 
 async function main() {
@@ -835,8 +837,15 @@ async function main() {
   const gitToken = process.env.GITHUB_GIT_TOKEN!;
   const inferenceToken = process.env.GITHUB_INFERENCE_TOKEN!;
 
+  const platform = new PlatformClient({
+    apiUrl,
+    jobId,
+    token: apiToken,
+    nonce,
+  });
+
   // 2. Fetch job details (problem statement, repo metadata, action type)
-  const job = await fetchJobDetails(apiUrl, jobId, apiToken, nonce);
+  const job = await platform.fetchJobDetails();
 
   // 3. Clone the repository
   const repoLocation = cloneRepo({

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+# This repository is maintained by:`
	`2`	`+* @github/coding-agent-core-team`