Contribution overview

General guidance for contributing to any of the Dapr project repositories

Thank you for your interest in Dapr! This document provides the guidelines for how to contribute to the Dapr project through issues and pull-requests. Contributions can also come in additional ways such as engaging with the community in community calls, commenting on issues or pull requests and more.

See the Dapr community repository for more information on community engagement and community membership.

If you are looking to contribute to the Dapr docs, please also see the specific guidelines for docs contributions.

Issues

Issue types

In most Dapr repositories there are usually 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 submitting

Before you submit 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.

Pull Requests

All contributions come through pull requests. To submit a proposed change, follow 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
    • Some Dapr repos support Codespaces to provide an instant environment for you to build and test your changes.
    • See the Developing Dapr docs for more information about setting up a Dapr development environment.
  3. Create your change
    • Code changes require tests
  4. Update relevant documentation for the change
  5. Commit with DCO sign-off 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.

Developer Certificate of Origin: Signing your work

Every commit needs to be signed

The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the DCO, reformatted for readability:

  1. By making a contribution to this project, I certify that:
  2.     (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
  3.     (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
  4.     (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.
  5.     (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.

Contributors sign-off that they adhere to these requirements by adding a Signed-off-by line to commit messages.

  1. This is my commit message
  2. Signed-off-by: Random J Developer <random@developer.example.org>

Git even has a -s command line option to append this automatically to your commit message:

  1. $ git commit -s -m 'This is my commit message'

Each Pull Request is checked whether or not commits in a Pull Request do contain a valid Signed-off-by line.

I didn’t sign my commit, now what?!

No worries - You can easily replay your changes, sign them and force push them!

  1. git checkout <branch-name>
  2. git commit --amend --no-edit --signoff
  3. git push --force-with-lease <remote-name> <branch-name>

Code of Conduct

Please see the Dapr community code of conduct.

Last modified June 23, 2022: Merge pull request #2550 from ItalyPaleAle/cosmosdb-harcoded-dapr-version (cf03237)