forked from Checkmarx/kics
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Adding additional docs assets, and updating documentation. * Fixing images location * Fixing broken links in readme * Updating logo * Deleting CONTRIBUTING.md - irrelevant * Minor readme changes. * Site URL change * Updating static site to include explicit link to repo * Updated readme, added license placeholder * Adding contribution page + updating 'about' page.
- Loading branch information
Igor Markov
authored
Nov 23, 2020
1 parent
2f2f86f
commit 9593b69
Showing
6 changed files
with
59 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
## Contribution | ||
|
||
We would like to THANK YOU for considering contributing to KICS! | ||
|
||
## Contribution Options | ||
|
||
TBD | ||
|
||
## Get Started! | ||
|
||
Follow the instructions below to setup local KICS development environment. | ||
|
||
1. Fork the `kics` repo on GitHub. | ||
2. Clone your fork locally: | ||
``` | ||
$ git clone terrascan.git | ||
``` | ||
3. Create a branch for local development: | ||
``` | ||
$ git checkout -b name-of-your-issue | ||
``` | ||
4. Make your changes locally. | ||
5. Validate your changes to reassure they meet project quality and contribution standards: | ||
``` | ||
$ fancy local command goes here | ||
``` | ||
5. Commit your changes and push your branch to GitHub: | ||
``` | ||
$ git add . | ||
$ git commit | ||
$ git push origin name-of-your-issue | ||
``` | ||
6. Submit a pull request through GitHub website. | ||
|
||
## Pull Request Guidelines | ||
|
||
Before you submit a pull request, please reassure that it meets these guidelines: | ||
|
||
1. All validations and tests passed locally. | ||
1. The pull request includes tests. | ||
1. The relevant docs are updated, whether you're pushing new functionality or updating a query. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters