Thank you for investing your time and interest in contributing to our project!
Read our Code of Conduct to keep our community approachable and respectable.
To get an overview of the project, read the README. Here are some resources to help you get started with open source contributions:
- Look at the Baton project wide Roadmap to learn about where the project's upcoming focus.
The Baton project lives over multiple git repositories. To get started:
- baton-sdk: Primary SDK library, which contains many core behaviors, data structures, and utilities.
- baton-cli: Baton Command Line tool, which can be used to explore data extracted by a connector.
baton-X, where X is a specific connector. For example baton-github contains the implementation of a GitHub connector. It leverages thebaton-sdkrepository as a dependency.
If you spot a problem with the Baton SDK, search if an issue already exists. If a related issue doesn't exist, you can open a new issue using a relevant issue form.
Scan through our existing issues to find one that interests you. As a general rule, we don’t assign issues to anyone. If you find an issue to work on, you are welcome to open a PR with a fix.
This is a rough outline of what a contributor's workflow looks like:
- Fork the repository on GitHub
- Read the README for build and test instructions
- Play with the project, submit bugs, submit patches!
Thanks for your contributions!
The Baton project takes security seriously. If you discover a security issue, please bring it to our attention right away!
Please DO NOT file a public issue or pull request, instead send your report privately to the ConductorOne Security Team, reachable at [email protected].
Security reports are greatly appreciated and we will publicly thank you for them.