@@ -17,39 +17,39 @@ Welcome to Kmesh!
1717 - [ Code Review] ( #code-review )
1818- [ Membership] ( #membership )
1919
20- # Before you get started
20+ ## Before you get started
2121
22- ## Code of Conduct
22+ ### Code of Conduct
2323
2424Please make sure to read and observe our [ Code of Conduct] ( /CODE_OF_CONDUCT.md ) .
2525
26- ## Community Expectations
26+ ### Community Expectations
2727
2828Kmesh is a community project driven by its community which strives to promote a healthy, friendly and productive environment.
2929Kmesh aims to provide turnkey automation for multi-cluster application management in multi-cloud and hybrid cloud scenarios,
3030and intended to realize multi-cloud centralized management, high availability, failure recovery and traffic scheduling.
3131
32- # Getting started
32+ ## Getting started
3333
3434- Fork the repository on GitHub.
3535- Make your changes on your fork repository.
3636- Submit a PR.
3737
38- # Your First Contribution
38+ ## Your First Contribution
3939
4040We will help you to contribute in different areas like filing issues, developing features, fixing critical bugs and
4141getting your work reviewed and merged.
4242
4343If you have questions about the development process,
4444feel free to [ file an issue] ( https://github.com/Kmesh-net/Kmesh/issues/new/choose ) .
4545
46- ## Find something to work on
46+ ### Find something to work on
4747
4848We are always in need of help, be it fixing documentation, reporting bugs or writing some code.
4949Look at places where you feel best coding practices aren't followed, code refactoring is needed or tests are missing.
5050Here is how you get started.
5151
52- ### Find a good first topic
52+ #### Find a good first topic
5353
5454There are [ multiple repositories] ( https://github.com/Kmesh-net/ ) within the Kmesh organization.
5555Each repository has beginner-friendly issues that provide a good first issue.
@@ -66,7 +66,7 @@ Please see [Contributing](#contributing) below for the workflow.
6666
6767When you are willing to take on an issue, just reply on the issue. The maintainer will assign it to you.
6868
69- ### File an Issue
69+ #### File an Issue
7070
7171While we encourage everyone to contribute code, it is also appreciated when someone reports an issue.
7272Issues should be filed under the appropriate Kmesh sub-repository.
@@ -75,7 +75,7 @@ Issues should be filed under the appropriate Kmesh sub-repository.
7575
7676Please follow the prompted submission guidelines while opening an issue.
7777
78- # Contributor Workflow
78+ ## Contributor Workflow
7979
8080Please do not ever hesitate to ask a question or send a pull request.
8181
@@ -86,28 +86,28 @@ This is a rough outline of what a contributor's workflow looks like:
8686- Push changes in a topic branch to a personal fork of the repository.
8787- Submit a pull request to [ Kmesh-net/Kmesh] ( https://github.com/Kmesh-net/Kmesh ) .
8888
89- ## Creating Pull Requests
89+ ### Creating Pull Requests
9090
9191Pull requests are often called simply "PR".
9292Kmesh generally follows the standard [ github pull request] ( https://help.github.com/articles/about-pull-requests/ ) process.
9393To submit a proposed change, please develop the code/fix and add new test cases.
9494After that, run these local verifications before submitting pull request to predict the pass or
9595fail of continuous integration.
9696
97- * Run and pass ` make gen-check ` , if want to run with sudo privileges ` sudo env PATH=$PATH make gen-check `
98- * To compile, refer to [ Compile and Build Kmesh] ( https://kmesh.net/en/docs/developer/build-guide/ )
99- * To run unit test, refer to [ Run Unit Test] ( https://kmesh.net/en/docs/developer/run-ut/ )
100- * To run e2e test, refer to [ Run E2E Test] ( https://kmesh.net/en/docs/developer/e2e-guide/ )
97+ - Run and pass ` make gen-check ` , if want to run with sudo privileges ` sudo env PATH=$PATH make gen-check `
98+ - To compile, refer to [ Compile and Build Kmesh] ( https://kmesh.net/en/docs/developer/build-guide/ )
99+ - To run unit test, refer to [ Run Unit Test] ( https://kmesh.net/en/docs/developer/run-ut/ )
100+ - To run e2e test, refer to [ Run E2E Test] ( https://kmesh.net/en/docs/developer/e2e-guide/ )
101101
102- ## Code Review
102+ ### Code Review
103103
104104To make it easier for your PR to receive reviews, consider the reviewers will need you to:
105105
106- * follow [ good coding guidelines] ( https://github.com/golang/go/wiki/CodeReviewComments ) .
107- * write [ good commit messages] ( https://chris.beams.io/posts/git-commit/ ) .
108- * break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.
106+ - follow [ good coding guidelines] ( https://github.com/golang/go/wiki/CodeReviewComments ) .
107+ - write [ good commit messages] ( https://chris.beams.io/posts/git-commit/ ) .
108+ - break large changes into a logical series of smaller patches which individually make easily understandable changes, and in aggregate solve a broader issue.
109109
110- # Membership
110+ ## Membership
111111
112112We encourage all contributors to become members. Learn more about requirements and responsibilities of membership in our [ Community Membership doc] ( https://kmesh.net/docs/community/membership/ ) .
113113
0 commit comments