Skip to content

Latest commit

 

History

History
109 lines (73 loc) · 6.9 KB

CONTRIBUTING.md

File metadata and controls

109 lines (73 loc) · 6.9 KB
Raw

Contributing Overview

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

All contributors are welcome. 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.

Not sure where to start? First, see the newcomers welcome guide. Grab an open issue with the help-wanted label and jump in. Join the Slack account 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.

Sections

Relevant coding style guidelines are the Go Code Review Comments and the Formatting and style section of Peter Bourgon's Go: Best Practices for Production Environments.

General Contribution Flow

In order to contribute to Meshery, 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 <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:

$ 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:

About GetNightHawk?

GetNighthawk aims to provide generally-available distributions of Nighthawk under different architectures and platforms and easy-to-use tooling for installation and operation. This will include creating distributions of Nighthawk as well as augmenting existing tooling, Meshery, to retrieve these arch-specific packages and update their deployments.

How to Contribute?

You can contribute to the GetNightHawk main project and documentation or you could help in building and contributing to the site which is running on Jekyll, a static site generator(SSG).

Steps to contribute to GetNightHawk project

  1. Visit the Project documentation
  2. Suggest requests, changes, or features by creating an issue on the repository
  3. Look at existing issues to tackle and get involved with

Steps to build GetNightHawk site

  1. Fork this repository
  2. Clone your forked copy to your local computer
  3. cd into the getnighthawk repo
  4. cd docs to access the GetNighthawk Jekyll website codebase
  5. Run the following code in your terminal bundle install.
  6. Run make site in order to serve the jekyll website on your machine at http://127.0.0.1:4000/ ( bundle exec jekyll serve can also be used for spinning up the Jekyll website at http://127.0.0.1:4000/)

UI Lint Rules

Layer5 uses ES-Lint to maintain code quality & consistency in our UI Code.

Reviews

All contributors are invited to review pull requests. See this short video on how to review a pull request.

New to Git?

Resources: https://lab.github.com and https://try.github.com/

Notes related to Nighthawk Transform function

  1. The format of results generated by Nighthawk is different than format of Fortio's result, to convert Nighthawk's results into Fortio compatible format we use transform function, based on the proto file.

  2. The proto file has discrepancies and is not completely compatible with fortio. Check the issue and go through comments for clarity.

  3. To handle this mismatched types, we have re-implemented Unmarshall function to facilitate compatibility.

In case of incompatibility in future, we need to alter the transorm function or Unmarshall function.

The above Unmarshall function needs to be removed once the issue is fixed.

License

This repository and site are available as open source under the terms of the Apache 2.0 License.

About Layer5

Community First

The Layer5 community represents the largest collection of service mesh projects and their maintainers in the world.

Open Source First

Our projects establish industry standards and enable service developers, owners, and operators with repeatable patterns and best practices for managing all aspects of distributed services. Our shared commitment to the open source spirit push the Layer5 community and its projects forward.