Skip to content

Latest commit

 

History

History
109 lines (75 loc) · 4.43 KB

CONTRIBUTE.md

File metadata and controls

109 lines (75 loc) · 4.43 KB

Contributing to NVTrust

Thank you for your interest in contributing to NVTrust! We welcome contributions from the community and are grateful for your support. Please take a moment to review this guide to understand how you can contribute to the project.

How to Contribute

Reporting Issues

If you encounter any bugs, have feature requests, or have questions, please open an issue on GitHub. When reporting issues, please provide as much detail as possible to help us understand and resolve the problem quickly.

  1. Go to the Issues page.
  2. Click on the "New Issue" button.
  3. Provide a clear and descriptive title.
  4. Describe the issue or feature request in detail, including steps to reproduce the issue if applicable.

Submitting Pull Requests

We welcome pull requests for bug fixes, improvements, and new features. To submit a pull request:

  1. Fork the repository on GitHub.
  2. Clone your fork to your local machine.
  3. Create a new branch for your changes: 
    git checkout -b my-feature-branch
  4. Make your changes and commit them with clear and concise messages.
  5. Push your changes to your forked repository: 
    git push origin my-feature-branch
  6. Open a pull request on the original repository. Provide a clear description of your changes and the problem they solve.

Coding Guidelines

To ensure a smooth and consistent codebase, please follow these guidelines:

  • Follow the existing code style.
  • Write clear, concise commit messages.
  • Include comments where necessary to explain the intent of the code.
  • Ensure your changes do not introduce new issues by running existing tests and adding new tests as needed.

Code of Conduct

To ensure a positive and inclusive community, we adhere to the Contributor Covenant Code of Conduct. By participating in this project, you agree to abide by its terms.

Getting Started

To get started with development:

  1. Clone the repository: 
    git clone https://github.com/NVIDIA/nvtrust.git
  2. Navigate to the project directory: 
    cd nvtrust
  3. Install the required dependencies (if applicable).

Signing Your Work

  • We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license.

    • Any contribution which contains commits that are not Signed-Off will not be accepted.

  • To sign off on a commit you simply use the --signoff (or -s) option when committing your changes:

    $ git commit -s -m "Add cool feature."

    This will append the following to your commit message:

    Signed-off-by: Your Name <your@email.com>

  • Full text of the DCO:

      Developer Certificate of Origin
  Version 1.1
  
  Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
  1 Letterman Drive
  Suite D4700
  San Francisco, CA, 94129
  
  Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.

      Developer's Certificate of Origin 1.1
  
  By making a contribution to this project, I certify that:
  
  (a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
  
  (b) The contribution is based upon previous work that, to the best of my knowledge, is covered under an appropriate open source license and I have the right under that license to submit that work with modifications, whether created in whole or in part by me, under the same open source license (unless I am permitted to submit under a different license), as indicated in the file; or
  
  (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
  
  (d) I understand and agree that this project and the contribution are public and that a record of the contribution (including all personal information I submit with it, including my sign-off) is maintained indefinitely and may be redistributed consistent with this project or the open source license(s) involved.

Contact

If you have any questions or need further assistance, feel free to reach out by opening an issue or contacting the maintainers.

Thank you for contributing to NVTrust!