Skip to content

Latest commit

 

History

History
79 lines (58 loc) · 5.52 KB

CONTRIBUTING.md

File metadata and controls

79 lines (58 loc) · 5.52 KB
Raw

Contributing Overview

Please do! Thanks for your help in improving the project! 🎈

All contributors are welcome. Not sure where to start? Please see the newcomers welcome guide for how, where, and why to contribute. This project is community-built and welcomes collaboration. Contributors are expected to adhere to our Code of Conduct.

All set to contribute? Grab an open issue with the help-wanted label and jump in. Join the Slack channel and engage in conversation. Create a new issue if needed. All pull requests should reference an open issue. Include keywords in your pull request descriptions, as well as commit messages, to automatically close issues in GitHub.

Note- SMP prominently and consistently engages with the Meshery Project. For a more complete set of contributing guides see docs.meshery.io/project/contributing.

General Contribution Flow

To contribute to Service Mesh Performance, please follow the fork-and-pull request workflow described here.

Signing-off on Commits (Developer Certificate of Origin)

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 DCO file for the full text of what you must agree to and how it works here. 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 <[email protected]>

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:

~/.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:

Set up Your Development Environment

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 Jekyll Docs.

Note: Windows users can run Jekyll by following the Windows Installation Guide, for Jekyll. This includes installing the Ruby Version Manager RVM - 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:

  • WSL1 for Windows build version 1607 or higher.
  • WSL2 for Windows build version 1903 or higher.

After successful installation, proceed with the following steps to run Jekyll on WSL.

If you face any errors during installation or setup, have a look at Meshery Contributing Docs to find a possible solution.

Documentation Contribution Flow

Please contribute! All projects under Layer5 use GitHub Pages to host its documentation. Learn more about Layer5's documentation framework. The process of contributing follows this flow:

  1. Create a fork, if you have not already, by following the steps described here
  2. In the local copy of your fork, navigate to the docs folder. cd docs
  3. Create and checkout a new branch to make changes within git checkout -b <my-changes>
  4. Edit/add documentation. vi <specific page>.md
  5. 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.
  1. Commit, sign-off, and push changes to your remote branch. git push origin <my-changes>
  2. Open a pull request (in your web browser) against our main repo: https://github.com/layer5io/service-mesh-performance.