Skip to content

Commit

Permalink
Updated Contributing Guidelines (#4453)
Browse files Browse the repository at this point in the history
* Updated Contributing Guidelines

Signed-off-by: Saranya-jena <[email protected]>

* added backstage plugin for contribution

Signed-off-by: Saranya-jena <[email protected]>

---------

Signed-off-by: Saranya-jena <[email protected]>
  • Loading branch information
Saranya-jena authored Feb 21, 2024
1 parent 84b76bd commit 6cfff16
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down

0 comments on commit 6cfff16

Please sign in to comment.