Welcome! We are glad that you want to contribute to our kernels
As you get started, you are in the best position to give us feedback on areas of our project that we need help with including:
- Problems found during setting up a new developer environment
- Gaps in our Getting started Guide or documentation
- Bugs in our automation scripts
If anything doesn't make sense, or doesn't work when you run it, please open a bug report and let us know!
We welcome many different types of contributions including:
- New features
- Builds, CI/CD
- Bug fixes
- Documentation
To begin contributing changes to notebook kernels, you'll need to setup your local environment
python: Version depending on which kernels being builtdocker: For building and testing images
git clone [email protected]:noteable-io/kernels
cd kernels/$kernel/
# Make proposed edits as needed
docker buildx bake <target>All commits to this repository must be signed by the author. Please review https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits for information on configuring your machine to do so.
When you submit your pull request, or you push new commits to it, our automated systems will run some checks on your new code. We require that your pull request passes these checks, but we also have more criteria than just that before we can accept and merge it. We recommend that you check the following things locally before you submit your code:
- I have performed a self-review of my code
- I am able to build images locally
- Has the issue it resolves been discussed with maintainers?
Note: This checklist is also part of the pull request template for this project