From 6cfff1688a70acac882757c82d7aaf6108d335c0 Mon Sep 17 00:00:00 2001 From: Saranya Jena Date: Wed, 21 Feb 2024 16:12:41 +0530 Subject: [PATCH] Updated Contributing Guidelines (#4453) * Updated Contributing Guidelines Signed-off-by: Saranya-jena * added backstage plugin for contribution Signed-off-by: Saranya-jena --------- Signed-off-by: Saranya-jena --- CONTRIBUTING.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c310849cdd..fa59864d234 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -8,9 +8,9 @@ Thanks for your interest in contributing to Litmus and help improve the project! ## Where to Begin! -If you have any queries or requests about Litmus please [create an issue](https://github.com/litmuschaos/litmus/issues/new) on GitHub. If you want to comment or ask questions to the contributors start by [joining our community](http://slack.litmuschaos.io) and drop your questions in the #litmus channel. +If you have any queries or requests about Litmus please [create an issue](https://github.com/litmuschaos/litmus/issues/new) on GitHub. If you want to comment or ask questions to the contributors start by [joining our community](http://slack.litmuschaos.io) and drop your questions in the **#litmus** channel. -If you want to do code contributions but you are fairly new to the tech stack we are using! Check out the [Development Guide](https://github.com/litmuschaos/litmus/wiki/Litmus-Portal-Development-Guide) to get a reference and help get started. +If you want to do code contributions but you are fairly new to the tech stack we are using! Check out the [Local Development Guide](https://github.com/litmuschaos/litmus/wiki/ChaosCenter-Development-Guide) and [Development Best Practices](https://github.com/litmuschaos/litmus/wiki/Development-Best-Practices) to get a reference and help get started. We welcome contributions of all kinds @@ -59,6 +59,7 @@ To submit any kinds of improvements, please consider the following: - If you are making a change to the user interface (UI), include a screenshot of the UI changes. - Follow the relevant coding style guidelines - For backend contributions, popular ones are the [Go Code Review Comments](https://code.google.com/p/go-wiki/wiki/CodeReviewComments) and the _Formatting_ and _style_ section of Peter Bourgon's [Go: Best Practices for Production Environments](https://peter.bourgon.org/go-in-production/#formatting-and-style). + - If you are making any changes in backend, make sure you have run and tested the code locally, the reviewers might ask for relevant screenshots in the comments. - For frontend contributions, we follow the [Airbnb style guide](https://airbnb.io/javascript/react/) - Your branch may be merged once all configured checks pass, including: - The branch has passed tests in CI. @@ -95,7 +96,10 @@ You can choose from a list of sub-dependent repos to contribute to, a few highli - [Chaos-workflows](https://github.com/litmuschaos/chaos-workflows) - [Test-tools](https://github.com/litmuschaos/test-tools) - [Litmus-go](https://github.com/litmuschaos/litmus-go) -- [website-litmuschaos](https://github.com/litmuschaos/website-litmuschaos) +- [Litmus-website](https://github.com/litmuschaos/litmus-website-2) +- [Litmusctl](https://github.com/litmuschaos/litmusctl) +- [Litmus-docs](https://github.com/litmuschaos/litmus-docs) +- [backstage-plugin](https://github.com/litmuschaos/backstage-plugin) ## Community