Skip to main content

Contributing

How to Contribute​

We warmly welcome contributions from the community to help enhance and expand the functionality of our SBOM generation tool. If you are interested in contributing, you can do so in the following ways:

Reporting Bugs:​

If you encounter any bugs or issues while using the tool, please open an issue on our GitHub repository detailing the problem, how to reproduce it, and any relevant logs or error messages.

Feature Requests:​

Have ideas on how to improve the tool? Submit a feature request through our GitHub issues, describing your proposed feature and how it would benefit users of the tool.

Pull Requests:​

Ready to contribute code? Great! You can submit pull requests with bug fixes, new features, or improvements to existing functionalities. Here's how to get started:

  • Fork the repository to your own GitHub account.
  • Clone the forked repository to your local machine.
  • Create a new branch for your changes: git checkout -b your-feature-branch.
  • Make your changes and commit them: git commit -am 'Add some feature'.
  • Push the changes to your fork: git push origin your-feature-branch.
  • Go to the original repository on GitHub, and you'll see a prompt to submit a pull request from your new branch.

Please note, all pull requests should be made against the main branch. Ensure that your code adheres to the existing coding standards and include any relevant tests. Pull requests require a review before merging.