Skip to content

Latest commit

 

History

History
55 lines (42 loc) · 1.67 KB

CONTRIBUTING.md

File metadata and controls

55 lines (42 loc) · 1.67 KB
Raw

Contribution

We would like to THANK YOU for considering contributing to KICS!

KICS is a true community project. It's built as an open source from day one, and anyone can find his own way to contribute to the project.

Within just minutes, you can start making a difference, by sharing your expertise with a community of thousands of security experts and software developers.

Contribution Options

Good news! You don't have to contribute code. There are plenty of ways you can contribute to KICS project:

  • Reporting new bugs or issues
  • Help triaging issues
  • Improving and translating the documentation
  • Volunteer to maintain the project

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 https://github.com/Checkmarx/kics.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
  6. Commit your changes and push your branch to GitHub: 
    git add .

    git commit

    git push --set-upstream origin <name-of-your-issue>
  7. Submit a pull request on 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.
  2. The pull request includes tests.
  3. The relevant docs are updated, whether you're pushing new functionality or updating a query.