Skip to content

Latest commit

 

History

History
41 lines (26 loc) · 1.77 KB

CONTRIBUTING.md

File metadata and controls

41 lines (26 loc) · 1.77 KB
Raw

Contributing

Thank you for considering to contribute to copilot-extensions/preview-sdk.js 💖

Please note that this project is released with a Contributor Code of Conduct. By participating you agree to abide by its terms.

Ways to contribute

  • Reporting bugs - if you find a bug, please report it!
  • Suggesting features - if you have an idea for a new feature, please suggest it!
  • Contribute dreamcode - like dreaming big? Same! Send a pull request with your beautiful API design that is so good, we just have to make it real: dreamcode.md!
  • Contribute code - Yes! Please! We might even have issues that are ready to be worked on!

Development

Prerequisites

  • Node.js (v22.x)

    We currently depend on Node 22+ for local development as we use new test APIs such as snapshot testing! At some point we might move to a different test runner, but this works great to move fast in early alpha days.

Setup

Use a codespace and you are all set: https://github.com/copilot-extensions/preview-sdk.js/codespaces.

Or, if you prefer to develop locally:

gh repo clone copilot-extensions/preview-sdk.js
cd preview-sdk.js
npm install

Running tests

npm test

As part of the tests, we test types for our public APIs (npm run test:types) and our code (npm run test:tsc). Run npm run to see all available scripts.