Project: Service Mesh Performance (Orchestration & Management / Service Mesh)
File: CONTRIBUTING.md

Please do! Thanks for your help in improving the project! :balloon: All contributors are welcome. Not sure where to start? Please see the for how, where, and why to contribute. This project is community-built and welcomes collaboration. Contributors are expected to adhere to our . All set to contribute? Grab an open issue with the and jump in. Join the and engage in conversation. Create a if needed. All should reference an open . Include keywords in your pull request descriptions, as well as commit messages, to . Note- SMP prominently and consistently engages with the Meshery Project. For a more complete set of contributing guides see docs.meshery.io/project/contributing. To contribute to Service Mesh Performance, please follow the fork-and-pull request workflow described . To contribute to this project, you must agree to the Developer Certificate of Origin (DCO) for each commit you make. The DCO is a simple statement that you, as a contributor, have the legal right to make the contribution. See the file for the full text of what you must agree to and how it works . To signify that you agree to the DCO for contributions, you simply add a line to each of your git commit messages: ``` Signed-off-by: Jane Smith <jane.smith@example.com> ``` In most cases, you can add this signoff to your commit automatically with the `-s` or `--signoff` flag to `git commit`. You must use your real name and a reachable email address (sorry, no pseudonyms or anonymous contributions). An example of signing off on a commit: ``` $ git commit -s -m my commit message w/signoff ``` To ensure all your commits are signed, you may choose to add this alias to your global ```.gitconfig```:

``` [alias] amend = commit -s --amend cm = commit -s -m commit = commit -s ``` Or you may configure your IDE, for example, Visual Studio Code to automatically sign-off commits for you: <a href="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" ><img src="https://user-images.githubusercontent.com/7570704/64490167-98906400-d25a-11e9-8b8a-5f465b854d49.png" width="50%"><a> The Service Mesh Performance site is built using Jekyll - a simple static site generator! You can learn more about Jekyll and setting up your development environment in the . First , then install Jekyll and Bundler. Note: Windows users can run Jekyll by following the , for Jekyll. This includes installing the Ruby Version Manager - a command-line tool that allows you to easily install, manage, and work with multiple ruby environments on your local machine. Alternatively, if you are running Windows 10, you may install the Windows Subsystem for Linux: for Windows build version 1607 or higher. for Windows build version 1903 or higher. After successful installation, proceed with the following to run Jekyll on WSL. If you face any errors during installation or setup, have a look at to find a possible solution. Please contribute! All projects under Layer5 use GitHub Pages to host its documentation. Learn more about . The process of contributing follows this flow: Create a fork, if you have not already, by following the steps described In the local copy of your fork, navigate to the docs folder. `cd docs` Create and checkout a new branch to make changes within `git checkout -b <my-changes>` Edit/add documentation. `vi <specific page>.md` Run site locally to preview changes. `make site` Note: From the Makefile, this command is actually running `$ bundle exec jekyll serve --drafts --livereload`. There are two Jekyll configuration, `jekyll serve` for developing locally and `jekyll build` when deploying for production based on differences of the handling of trailing slashes between Jekyll and GitHub Pages.* Commit, , and push changes to your remote branch. `git push origin <my-changes>` Open a pull request (in your web browser) against our main repo: https://github.com/service-mesh-performance/service-mesh-performance.