Skip to content

Latest commit

 

History

History
59 lines (43 loc) · 2.4 KB

CONTRIBUTING.md

File metadata and controls

59 lines (43 loc) · 2.4 KB
Raw

Contributing

Thank you for considering contributing to KubiScan! We welcome contributions to improve this project. For general contribution and community guidelines, please see the community repo.

Contributing

  1. Fork the project
  2. Clone your fork
  3. Make local changes to your fork by editing files
  4. Commit your changes
  5. Push your local changes to the remote server
  6. Create new Pull Request

From here your pull request will be reviewed and once you've responded to all feedback it will be merged into the project. Congratulations, you're a contributor!

Development

To start developing and testing using our development scripts , the following tools need to be installed:

  • Docker
  • Minikube (or any other local Kubernetes setup)

Running tests

[1] Commit and push your changes to your repository.
[2] Make sure docker is installed on the host.
[3] Start MiniKube.
[4] Type the following commands:
    "cd /tmp"
    "git clone <your repo>"
    "cd KubiScan/unit_test/"
    "./kubectl_apply.sh"
[5] For the unit-test run the following command:
    python3 -m pytest -v unit_test.py

Releases

Maintainers only should create releases. Follow these steps to prepare for a release.

Pre-requisites

  1. Review recent commits and ensure the changelog includes all relevant changes, with references to GitHub issues or PRs when applicable.
  2. Verify that any updated dependencies are accurately reflected in the NOTICES.
  3. Confirm that required documentation is complete and has been approved.
  4. Scan the project for vulnerabilities

Release and Promote

  1. Merging to the main branch will trigger an automated release build. Successful builds can be promoted at a later time.
  2. Use build parameters in CI/CD tools to promote a release or manually trigger additional builds if needed.

Thank you for contributing to KubiScan!