Welcome! We are glad that you want to contribute to our project! 💖
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 Quickstart 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
- Issue Triage
- Answering questions on the Holo Forum or Edge Node Support Telegram
- Web design
- Communications / Social Media / Blog Posts
- Release management
Not everything happens through a GitHub pull request. Please come to our Holo Huddles or contact us either on the Holo Forum or Edge Node Support Telegram and let's discuss how we can work together.
Absolutely everyone is welcome to come to any of our Holo Huddles who is there to support the purpose of that gathering. You never need an invite to join us. In fact, we want you to join us, even if you don’t have anything you feel like you want to contribute. Just being there is enough!
You can find out more about our Holo Huddles here. You don’t have to turn on your video. The first time you come, introducing yourself is more than enough. Over time, we hope that you feel comfortable voicing your opinions, giving feedback on others’ ideas, and even sharing your own ideas, and experiences.
We have good first issues for new contributors and help wanted issues suitable for any contributor. good first issue has extra information to help you make your first contribution. help wanted are issues suitable for someone who isn't a core maintainer and is good to move onto after your first pull request.
Sometimes there won’t be any issues with these labels. That’s ok! There is likely still something for you to work on. If you want to contribute but you don’t know where to start or can't find a suitable issue, you can submit an issue introducing yourself with your skillsets and interests so we can find a good fit for you.
Once you see an issue that you'd like to work on, please use the contributeToIssue label to indicate your interest.
The best way to reach us with a question when contributing is to ask on:
- The original github issue
- Please comment on an existing issue or create a new one to let us know what it is you want to work on and outline your proposed solution, so we can ensure your pull request will match the requirements for our project.
- Fork the repo, and submit a pull request when you are ready.
- We will review the pull request and may ask for revisions before we approve it.
- Once we approve it, we will merge the pull request.
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:
TBD: