This guide covers how to start contributing to Sedna 😄
Sedna is developed on GitHub and will require an account for contribution.
You may come back to this later, but we highly recommend reading these:
- Kubernetes Contributor Guide
- Main contributor documentation, or you can just jump directly to the contributing section
- Contributor Cheat Sheet
- Common resources for existing developers
These proposals cover framework and multi edge-cloud synergy capabilities of the project, which may be helpful to review before contributing.
Issues are tracked on GitHub. Please check the issue tracker to see if there is any existing discussion or work related to your interests.
In particular, if you're just getting started, you may want to look for issues labeled good first issue or help wanted which are standard labels in the Kubernetes project. The help wanted label marks issues we're actively seeking help with while good first issue is additionally applied to a subset of issues we think will be particularly good for newcomers.
See Kubernetes help wanted for best practices.
If you're interested in working on any of these, leave a comment to let us know!
And please reach out in general for bugs, feature requests, and other issues! If you do not see anything, please file a new issue.
NOTE: Please file an enhancement / feature request issue to discuss features before filing a PR (ideally even before writing any code), we have a lot to consider with respect to our existing users and future support when accepting any new feature.
To streamline the process, please reach out and discuss the concept and design / approach ASAP so the maintainers and community can get involved early.
-
If you're looking to contribute documentation improvements, you'll specifically want to see the kubernetes documentation style guide before filing an issue.
-
If you're planning to contribute code changes, you'll want to read the development preparation guide next.
-
If you're planning to add a new synergy feature directly, you'll want to read the guide next.
When done, you can also refer our recommended Git workflow and pull request best practices before submitting a pull request.