Skip to content

Latest commit

 

History

History
48 lines (38 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

48 lines (38 loc) · 2.46 KB

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.

Submitting a pull request

  1. Fork and clone the repository.
  2. Install the dependencies with Node.js 22.15.0 or newer (24+ recommended): npm ci
  3. Make sure the lint passes on your machine: npm run lint
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change. For a new plugin, follow Add a plugin. Follow the version rules: bump changes since a known released base, but keep an unreleased first version. Never lower versions or rewrite history, and ask if release status is unknown.
  6. Run npm run lint and the relevant catalog, schema, pin, and script checks. Lint alone doesn't validate marketplace or plugin metadata.
  7. Push to your fork and submit a pull request. Say what changed, and for a plugin that runs code, what it runs, what it reads, writes, and reaches, and what data it keeps or sends to the model.
  8. Pat yourself on the back and wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Use only synthetic data. Never commit secrets, tokens, or private code.
  • Write a good commit message.

Resources