Contribution Guidelines

September 24, 2023 ยท View on GitHub

Thank you for considering contributing to Diggity! We welcome contributions from the community to help improve and enhance our project. Before you get started, please take a moment to review the following guidelines to ensure a smooth and collaborative contribution process.

Code of Conduct

Please review our Code of Conduct before contributing. We are committed to providing a welcoming and inclusive environment for all contributors.

How to Contribute

Reporting Issues

If you encounter a bug, have a feature request, or want to suggest an improvement, please open an issue on our GitHub Issue Tracker. When creating an issue, please provide as much detail as possible, including:

  • A clear and concise description of the issue or enhancement request.
  • Steps to reproduce the issue (if applicable).
  • Screenshots or error messages (if relevant).
  • Information about your environment (e.g., operating system, Go version).

Pull Requests

We welcome pull requests for bug fixes, new features, and improvements. To contribute code, follow these steps:

  1. Fork the Diggity repository to your GitHub account.
  2. Clone your fork to your local machine:
git clone https://github.com/carbonetes/diggity.git
  1. Create a new branch for your changes:
git checkout -b feature-or-fix-name
  1. Make your code changes, ensuring adherence to our coding standards.
  2. Commit your changes with a descriptive commit message: 
git commit -m "Add your descriptive message here"

Note: Please refer to this format Karma 6.4 for your commit messages.
6. Push your branch to your fork on GitHub:

git push origin feature-or-fix-name
  1. Create a pull request (PR) from your branch to the main Diggity repository. Be sure to include a clear description of your changes in the PR.
  2. Your PR will be reviewed by our team. Please be patient during the review process, and be prepared to make additional changes if requested.

Development Setup

To set up Diggity for development, please follow the instructions in our Development Setup Guide.

Code Style

Please adhere to our coding standards and style guidelines to maintain consistency throughout the project. We recommend using Go's official coding style and conventions.

Licensing

By contributing to Diggity, you agree to license your contributions under the terms of the Apache 2.0. All contributions will be subject to this license.

Contact

If you have any questions, need clarification, or want to discuss potential contributions, please don't hesitate to contact us at eng@carbonetes.com.

Thank you for contributing to Diggity and helping make SBOM generation more accessible and secure for everyone!