From ced4a7a43bda3748cf73a060d463e8f19ccdb445 Mon Sep 17 00:00:00 2001 From: Monish Singh <36487698+xmonish@users.noreply.github.com> Date: Fri, 2 Oct 2020 11:43:48 +0530 Subject: [PATCH] added title image , fixed a link & few typos (#2164) --- CONTRIBUTING.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 35cc368b1..43d73f311 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,6 @@ -# Contributing to Litmus + + +# Contributing to Litmus : Litmus is an Apache 2.0 Licensed project and uses the standard GitHub pull requests process to review and accept contributions. @@ -9,20 +11,20 @@ There are several areas of Litmus that could use your help. For starters, you co * If you would like to work on something more involved, please connect with the Litmus Contributors. * If you would like to make code contributions, all your commits should be signed with Developer Certificate of Origin. See [Sign your work](#sign-your-work). -## Steps to Contribute +## Steps to Contribute : * Find an issue to work on or create a new issue. The issues are maintained at [litmuschaos/litmus](https://github.com/litmuschaos/litmus/issues). You can pick up from a list of [good-first-issues](https://github.com/litmuschaos/litmus/labels/good%20first%20issue). * Claim your issue by commenting your intent to work on it to avoid duplication of efforts. * Fork the repository on GitHub. * Create a branch from where you want to base your work (usually master). * Make your changes. -* Relevant coding style guidelines 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](http://peter.bourgon.org/go-in-production/#formatting-and-style). +* Relevant coding style guidelines 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). * Commit your changes by making sure the commit messages convey the need and notes about the commit. * Push your changes to the branch in your fork of the repository. * Submit a pull request to the original repository. See [Pull Request checklist](#pull-request-checklist) -## Pull Request Checklist +## Pull Request Checklist : * Rebase to the current master branch before submitting your pull request. * Commits should be as small as possible. Each commit should follow the checklist below: @@ -34,7 +36,7 @@ There are several areas of Litmus that could use your help. For starters, you co * If your PR is not getting reviewed or you need a specific person to review it, please reach out to the Litmus contributors at the [Litmus slack channel](https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN) -## Sign your work +## Sign your work We use the Developer Certificate of Origin (DCO) as an additional safeguard for the LitmusChaos project. This is a well established and widely used mechanism to assure that contributors have confirmed their right to license their contribution under the project's license. Please add a line to every git commit message: