You can not select more than 25 topics Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.

getting-started.md 4.1 kB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  1. This guide covers how to start contributing to Sedna 😄
  2. ## 1. Familiarize Yourself With Contributing to Sedna
  3. ### Setup GitHub Account
  4. Sedna is developed on [GitHub][github] and will require
  5. an account for contribution.
  6. ### Check The Kubernetes Contributor Guides
  7. You may come back to this later, but we highly recommend reading these:
  8. - [Kubernetes Contributor Guide](https://git.k8s.io/community/contributors/guide)
  9. - Main contributor documentation, or you can just jump directly to the [contributing section](https://git.k8s.io/community/contributors/guide#contributing)
  10. - [Contributor Cheat Sheet](https://git.k8s.io/community/contributors/guide/contributor-cheatsheet)
  11. - Common resources for existing developers
  12. ### Read The Sedna Docs
  13. These [proposals] cover framework and multi edge-cloud synergy capabilities of the project, which may be helpful to review before contributing.
  14. ### Reaching Out
  15. Issues are tracked on GitHub. Please check [the issue tracker][issues] to see
  16. if there is any existing discussion or work related to your interests.
  17. In particular, if you're just getting started, you may want to look for issues
  18. labeled <a href="https://github.com/kubeedge/sedna/labels/good%20first%20issue" class="gh-label" style="background: #7057ff; color: white">good first issue</a> or <a href="https://github.com/kubeedge/sedna/labels/help%20wanted" class="gh-label" style="background: #006b75; color: white">help wanted</a> which are standard labels in the Kubernetes project.
  19. The <a href="https://github.com/kubeedge/sedna/labels/help%20wanted" class="gh-label" style="background: #006b75; color: white">help wanted</a> label marks issues we're actively seeking help with while <a href="https://github.com/kubeedge/sedna/labels/good%20first%20issue" class="gh-label" style="background: #7057ff; color: white">good first issue</a> is additionally applied to a subset of issues we think will be particularly good for newcomers.
  20. See [Kubernetes help wanted] for best practices.
  21. If you're interested in working on any of these, leave a comment to let us know!
  22. And please reach out in general for bugs, feature requests, and other issues!
  23. If you do not see anything, please [file a new issue][file-an-issue].
  24. > **NOTE**: _Please_ file an enhancement / [feature request issue][file-a-fr] to discuss features before filing a PR (ideally even before writing any code), we have a lot to consider with respect to our
  25. > existing users and future support when accepting any new feature.
  26. >
  27. > To streamline the process, please reach out and discuss the concept and design
  28. > / approach ASAP so the maintainers and community can get involved early.
  29. ## 2. What's Next?
  30. - If you're looking to contribute documentation improvements, you'll specifically want to see the [kubernetes documentation style guide] before [filing an issue][file-an-issue].
  31. - If you're planning to contribute code changes, you'll want to read the [development preparation guide] next.
  32. - If you're planning to add a new synergy feature directly, you'll want to read the [guide][add-feature-guide] next.
  33. When done, you can also refer our [recommended Git workflow] and [pull request best practices] before submitting a pull request.
  34. [proposals]: /docs/proposals
  35. [development preparation guide]: ./prepare-environment.md
  36. [add-feature-guide]: control-plane/add-a-new-synergy-feature.md
  37. [issues]: https://github.com/kubeedge/sedna/issues
  38. [file-an-issue]: https://github.com/kubeedge/sedna/issues/new/choose
  39. [file-a-fr]: https://github.com/kubeedge/sedna/issues/new?labels=kind%2Ffeature&template=enhancement.md
  40. [github]: https://github.com/
  41. [kubernetes documentation style guide]: https://github.com/kubernetes/community/blob/master/contributors/guide/style-guide.md
  42. [recommended Git workflow]: https://github.com/kubernetes/community/blob/master/contributors/guide/github-workflow.md#workflow
  43. [pull request best practices]: https://github.com/kubernetes/community/blob/master/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
  44. [Kubernetes help wanted]: https://www.kubernetes.dev/docs/guide/help-wanted/