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.
Before you contribute, there are a few important steps you need to follow:
-
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.
-
DIF Agreements:
- If you're already a DIF Member, sign the DID Methods WG agreement: Select "DID Methods" WG on the Joint WG selector form
- If you're an Unaffiliated Individual: Sign the DIF Feedback Agreement and select "DID Methods" WG
- Not a DIF Member, participating on behalf of an Organization:
- If you'd like to join DIF, start here or contact us at [email protected]
- If you're a member of ToIP, W3C CCG, W3C DID Method WG, or INATBA (see 5.1 in the Operating Addendum for the latest list of organizations):
- Sign the DIF Contributor Agreement
- Sign the DID Methods WG agreement: Select "DID Methods" WG on the Joint WG selector form
- If you have questions, including if you'd like to request organization's inclusion in the participation agreement, email [email protected]
- 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.
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.
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.
- 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
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
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.