Skip to content

Latest commit

 

History

History
47 lines (32 loc) · 1.76 KB

CONTRIBUTING.md

File metadata and controls

47 lines (32 loc) · 1.76 KB

Contributing to Oso

Responsible disclosure

If you believe you have discovered a security vulnerability in Oso, please send details of the issue to [email protected]. Please do not open a GitHub issue or otherwise comment about the issue in a public forum.

Need help getting started?

If you're struggling to get set up with Oso or have questions about usage, check out the documentation or join us on Slack to ask questions.

Reporting issues

If you would like to report a bug, please first ensure that the bug has not already been reported by searching the project's open issues on GitHub.

If you can't find an existing issue, please open a new one. Be sure to include as much detail as possible, including a reproducible code sample.

Contributing code

If you would like to contribute to this project, please open a pull request with your changes. If you haven't already read and signed our Contributor License Agreement, you will be asked to do so upon opening your first PR. Thank you for contributing!

Publishing a Release

These steps are only relevant to Oso employees when preparing and publishing a new SDK release.

  1. Create a new branch off of main. Push the branch to remote.
  2. Run yarn lerna version --no-private. This pushes versioning commits and release package to remote.
  3. Create a PR towards the main branch.
  4. After the PR is merged, publish the release using the publish workflow.