Skip to content

Latest commit

 

History

History
64 lines (42 loc) · 2.7 KB

CONTRIBUTING.md

File metadata and controls

64 lines (42 loc) · 2.7 KB
Raw

Contributing

Thank you for your interest in contributing to our project! This document provides the guidelines for contributing. We appreciate your efforts and want to ensure that your contributions align with our project's policies.

Prerequisites

Before you contribute, there are a few important steps you need to follow:

  1. License Agreement:

    • All contributions are subject to the project’s license as outlined in the LICENSE file. Please review this to understand how your contributions will be used.

  2. DIF Agreements:

    • If you are contributing to components governed by the Decentralized Identity Foundation (DIF), you must sign the relevant DIF agreements. This is essential to comply with legal standards and community policies. Please visit DIF's site to complete this process.

  3. Code of Conduct:

    • We are committed to providing a welcoming and inspiring community for all. Please read and understand our Code of Conduct before participating in this project.

How to Contribute

Reporting Issues

Please follow these guidelines for reporting bugs:

  • Use our issue tracker to report bugs.
  • Include a clear description of the issue with as much detail as possible.
  • Attach screenshots if possible to clarify the problem.

Submitting Changes

Here’s how you can submit your changes:

  • Fork the repository on GitHub.
  • Create a new branch for your changes.
  • Make your modifications and write clear, concise commit messages.
  • Submit a pull request with a comprehensive description of your changes.

Pull Request Guidelines

  • Ensure that each pull request adheres to our coding standards and passes all tests.
  • Include updates to documentation if your changes introduce or modify any functionalities.
  • Ensure proper attribution in your pull request (see "Ensuring Proper Attribution in Pull Requests")
  • A project maintainer will merge the PR after obtaining the requisite number of reviews

Ensuring Proper Attribution in Pull Requests

If you are not the sole contributor to a contribution (pull request), please identify all contributors in the pull request comment.

To add a contributor (other than yourself, that's automatic), mark them one per line as follows:

+@github_username

If you added a contributor by mistake, you can remove them in a comment with:

-@github_username

Getting Help

If you have any questions or need help, please email the project maintainers listed in CODEOWNERS.

We look forward to your contributions and thank you for ensuring compliance with the prerequisites and contributing guidelines.