65 строки
3.0 KiB
Markdown
65 строки
3.0 KiB
Markdown
|
# Contribution Guidelines
|
||
|
|
|
||
|
|
Thank you for your interest in Verifiable Credentials!
|
||
|
|
|
||
|
|
This project welcomes contributions and suggestions. Most contributions require you to
|
||
|
|
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
|
||
|
|
and actually do, grant us the rights to use your contribution.
|
||
|
|
|
||
|
|
For details, visit https://cla.microsoft.com.
|
||
|
|
|
||
|
|
When you submit a pull request, a CLA-bot will automatically determine whether you need
|
||
|
|
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
|
||
|
|
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||
|
|
|
||
|
|
This project has adopted the Microsoft Open Source Code of Conduct.
|
||
|
|
For more information see the Code of Conduct FAQ
|
||
|
|
or contact opencode@microsoft.com with any additional questions or comments.
|
||
|
|
|
||
|
|
Contributions come in many forms: submitting issues, writing code, participating in discussions and community calls.
|
||
|
|
|
||
|
|
This document provides the guidelines for how to contribute to the Verifiable Credentials Wallet SDK project.
|
||
|
|
|
||
|
|
## Issues
|
||
|
|
|
||
|
|
This section describes the guidelines for submitting issues
|
||
|
|
|
||
|
|
### Issue Types
|
||
|
|
|
||
|
|
There are 4 types of issues:
|
||
|
|
|
||
|
|
- Issue/Bug: You've found a bug with the code, and want to report it, or create an issue to track the bug.
|
||
|
|
- Issue/Discussion: You have something on your mind, which requires input form others in a discussion, before it eventually manifests as a proposal.
|
||
|
|
- Issue/Proposal: Used for items that propose a new idea or functionality. This allows feedback from others before code is written.
|
||
|
|
- Issue/Question: Use this issue type, if you need help or have a question.
|
||
|
|
|
||
|
|
## Contributing
|
||
|
|
|
||
|
|
This section describes the guidelines for contributing code / docs to the project.
|
||
|
|
|
||
|
|
### Pull Requests
|
||
|
|
|
||
|
|
All contributions come through pull requests. To submit a proposed change, we recommend following this workflow:
|
||
|
|
|
||
|
|
1. Make sure there's an issue (bug or proposal) raised, which sets the expectations for the contribution you are about to make.
|
||
|
|
2. Fork the relevant repo and create a new branch
|
||
|
|
3. Create your change
|
||
|
|
- Code changes require tests
|
||
|
|
4. Update relevant documentation for the change
|
||
|
|
5. Commit and open a PR
|
||
|
|
6. Wait for the CI process to finish and make sure all checks are green
|
||
|
|
7. A maintainer of the project will be assigned, and you can expect a review within a few days
|
||
|
|
|
||
|
|
#### Use work-in-progress PRs for early feedback
|
||
|
|
|
||
|
|
A good way to communicate before investing too much time is to create a "Work-in-progress" PR and share it with your reviewers. The standard way of doing this is to add a "[WIP]" prefix in your PR's title and assign the **do-not-merge** label. This will let people looking at your PR know that it is not well baked yet.
|
||
|
|
|
||
|
|
### Use of Third-party code
|
||
|
|
|
||
|
|
- Third-party code must include licenses.
|
||
|
|
|
||
|
|
**Thank You!** - Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.
|
||
|
|
|
||
|
|
## Code of Conduct
|
||
|
|
|
||
|
|
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|