Welcome Newcomers!
Whether you are a first time contributor or an open source veteran, you are welcome to contribute to and actively engage in the development of projects at Layer5. Here are some instructions to get you started and if you haven’t joined yet, join the Slack workspace to collaborate with the community and the discussion forum for questions. Also, you can check the quick-links below for jumping straight into things.
Contributor's Journey
Start Here
How to Contribute?
These steps outline the process by which you can openly engage, learn, and participate in the broad set of open source projects at Layer5. If at any time you get stuck, please seek help in the community forum. Our MeshMates and community members are here to help!
Fill in the Community Member Form
Help us get to know you, so that we can highlight projects and initiatives that align with your interests. Fill-in a community member form. Gain access to community resources.
Finding an Issue to Work On
Note that the Layer5 community spans five GitHub organizations. See all in the repository overview.
- Browse the list of Layer5 org issues bearing the “good first issue” label, “first timers only” or the “help wanted” label.
- Find an area of interest by perusing the list of projects by repository and technology in the Layer5 Repository Overview.
- After identifying the issue you wish to work on, check whether it has been assigned or not by taking a look at the assignee section on the issue. If it hasn't been, signal your interest by commenting on the issue, so that it can be assigned to you.
Working on Your Issue
- Once an issue has been assigned to you, it’s time to get started! Make sure you take a look at the Contributing Guidelines.
- Be sure to sign-off on your commits.
- Contributions of all sizes are welcome.
- If you need some additional help, please join Layer5 discussion forum or find your way to the #newcomers channel in our Slack workspace. Introduce yourself and ask questions.
While Your Issue is Under Review
Be patient. There are a large number of contributors and only a small number of maintainers/reviewers. All contributors are equally important to us, and we'll be sure to get to you as soon as possible. In the meanwhile, you are welcome to engage in the Layer5 discussion forum, join our Slack workspace and take a look at all our projects.
Tutorials
Checkout some of the resources to get going
| Topic | Resources | Presenters |
|---|---|---|
| An Introduction to Contributing to Meshery | Vijay Cherukuri | |
| An Introduction to mesheryctl | Nupur Thakur | |
| A tutorial on contributing to Layer5 and working with Git | Ruth Ikegah | |
| An introduction to all Layer5 repositories | Lee Calcote | |
| A tutorial on Gatsby | Jash PatelTanuj Agarwal | |
| Functional Testing with Cypress in Meshery UI | Rodolfo Martinez Vega | |
| Beginner's guide to contributing to Meshery and mesheryctl | Navendu Pottekkat | |
| Contributing to Meshery API Swagger Documentation | Piyush Singariya | |
| Working with Meshery Docs and Jekyll | Aadhitya Amarendiran |
