Skip to content

Latest commit

 

History

History
128 lines (84 loc) · 6.26 KB

CONTRIBUTING.md

File metadata and controls

128 lines (84 loc) · 6.26 KB
Raw

Contributing to Dapr Rust SDK

Thank you for your interest in the Dapr Rust SDK!

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 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 [email protected] 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 Dapr 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.

Before You File

Before you file an issue, make sure you've checked the following:

  1. Is it the right repository?
    • The Dapr project is distributed across multiple repositories. Check the list of repositories if you aren't sure which repo is the correct one.
  2. Check for existing issues
    • Before you create a new issue, please do a search in open issues to see if the issue or feature request has already been filed.
    • If you find your issue already exists, make relevant comments and add your reaction. Use a reaction:
      • 👍 up-vote
      • 👎 down-vote
  3. For bugs
    • Check it's not an environment issue. For example, if running on Kubernetes, make sure prerequisites are in place. (state stores, bindings, etc.)
    • You have as much data as possible. This usually comes in the form of logs and/or stacktrace. If running on Kubernetes or other environment, look at the logs of the Dapr services (runtime, operator, placement service). More details on how to get logs can be found here.
  4. For proposals
    • Many changes to the Dapr runtime may require changes to the API. In that case, the best place to discuss the potential feature is the main Dapr repo.
    • Other examples could include bindings, state stores or entirely new components.

Contributing to Dapr

This section describes the guidelines for contributing code / docs to Dapr.

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

  • All third-party code must be placed in the vendor/ folder.
  • vendor/ folder is managed by Go modules and stores the source code of third-party Go dependencies. - The vendor/ folder should not be modified manually.
  • Third-party code must include licenses.

A non-exclusive list of code that must be places in vendor/:

  • Open source, free software, or commercially-licensed code.
  • Tools or libraries or protocols that are open source, free software, or commercially licensed.

Thank You! - Your contributions to open source, large or small, make projects like this possible. Thank you for taking the time to contribute.

Fork and set upstream

From the GitHub project at https://github.com/dapr/rust-sdk, click fork to create your own copy of the repository.

Clone your fork of the code:

git clone https://github.com/<USER-NAME>/rust-sdk

Change directory into the project with cd rust-sdk.

From the root of the project, set the upstream branch to the original project repository:

git remote add upstream https://github.com/dapr/rust-sdk

This will allow you to rebase your fork ontop of the changes pushed to the original.

Updating your fork

As your work progresses, it is helpful to regularly update your fork of the code to replay the work you have done on top of the latest code pushed to the original repository. In the above section, you set the upstream repository to the original code. Now, you can ensure you are always working with the latest code by pulling it in to your fork.

Fetch the latest updates to the original repository:

git fetch upstream

If you want to rebase your branch ontop of the original repository's master branch:

git rebase upstream/master

This will replay the changes you have made in your branch on top of the upstream master branch. The same principle applies to other branches in the original repository as well.

Code of Conduct

This project has adopted the Microsoft Open Source Code of Conduct.