Skip to content

Latest commit

 

History

History
104 lines (79 loc) · 4.83 KB

CONTRIBUTING.md

File metadata and controls

104 lines (79 loc) · 4.83 KB
Raw

Thank you for taking interest in contributing to Trivy!

Issues

  • Feel free to open issues for any reason. When you open a new issue, you'll have to select an issue kind: bug/feature/support and fill the required information based on the selected template.
  • Please spend a small amount of time giving due diligence to the issue tracker. Your issue might be a duplicate. If it is, please add your comment to the existing issue.
  • Remember that users might search for your issue in the future, so please give it a meaningful title to help others.
  • The issue should clearly explain the reason for opening, the proposal if you have any, and any relevant technical information.

Pull Requests

  1. Every Pull Request should have an associated bug or feature issue unless you are fixing a trivial documentation issue.
  2. Please add the associated Issue link in the PR description.
  3. Your PR is more likely to be accepted if it focuses on just one change.
  4. There's no need to add or tag reviewers.
  5. If a reviewer commented on your code or asked for changes, please remember to respond with comment. Do not mark discussion as resolved. It's up to reviewer to mark it resolved (in case if suggested fix addresses problem properly). PRs with unresolved issues should not be merged (even if the comment is unclear or requires no action from your side).
  6. Please include a comment with the results before and after your change.
  7. Your PR is more likely to be accepted if it includes tests (We have not historically been very strict about tests, but we would like to improve this!).
  8. If your PR affects the user experience in some way, please update the README.md and the CLI help accordingly.

Title

It is not that strict, but we use the title conventions in this repository. Each commit message doesn't have to follow the conventions as long as it is clear and descriptive since it will be squashed and merged.

Format of the title

<type>(<scope>): <subject>

The type and scope should always be lowercase as shown below.

Allowed <type> values:

  • feat for a new feature for the user, not a new feature for build script. Such commit will trigger a release bumping a MINOR version.
  • fix for a bug fix for the user, not a fix to a build script. Such commit will trigger a release bumping a PATCH version.
  • perf for performance improvements. Such commit will trigger a release bumping a PATCH version.
  • docs for changes to the documentation.
  • style for formatting changes, missing semicolons, etc.
  • refactor for refactoring production code, e.g. renaming a variable.
  • test for adding missing tests, refactoring tests; no production code change.
  • build for updating build configuration, development tools or other changes irrelevant to the user.
  • chore for updates that do not apply to the above, such as dependency updates.

Example <scope> values:

  • alpine
  • redhat
  • ruby
  • python
  • terraform
  • report
  • etc.

The <scope> can be empty (e.g. if the change is a global or difficult to assign to a single component), in which case the parentheses are omitted.

Example titles

feat(alma): add support for AlmaLinux

fix(oracle): handle advisories with ksplice versions

docs(misconf): add comparison with Conftest and TFsec

chore(deps): bump go.uber.org/zap from 1.19.1 to 1.20.0

NOTE: please do not use chore(deps): update fanal and something like that if you add new features or fix bugs in Trivy-related projects. The PR title should describe what the PR adds or fixes even though it just updates the dependency in Trivy.

Unit tests

Your PR must pass all the unit tests. You can test it as below.

$ make test

Integration tests

Your PR must pass all the integration tests. You can test it as below.

$ make test-integration

Documentation

You can build the documents as below and view it at http://localhost:8000.

$ make mkdocs-serve

Understand where your pull request belongs

Trivy is composed of several different repositories that work together:

  • Trivy is the client-side, user-facing, command line tool.
  • vuln-list is a vulnerabilities database, aggregated from different sources, and normalized for easy consumption. Think of this as the "server" side of the trivy command line tool. There should be no pull requests to this repo
  • vuln-list-update is the code that maintains the vuln-list database.
  • trivy-db maintains the vulnerability database pulled by Trivy CLI.
  • fanal is a library for extracting system information from containers. It is being used by Trivy to find testable subjects in the container image.