Skip to content

Latest commit

 

History

History
181 lines (123 loc) · 9.99 KB

CONTRIBUTING.md

File metadata and controls

181 lines (123 loc) · 9.99 KB
Raw

Contribution Guidelines

Thank you for your interest in Dapr!

This project welcomes contributions and suggestions. Most contributions require you to signoff on your commits via the Developer Certificate of Origin (DCO). When you submit a pull request, a DCO-bot will automatically determine whether you need to provide signoff for your commit. Please follow the instructions provided by DCO-bot, as pull requests cannot be merged until the author(s) have provided signoff to fulfill the DCO requirement. You may find more information on the DCO requirements below.

This project has adopted the Contributor Covenant Code of Conduct.

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.

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:

By making a contribution to this project, I certify that:

    (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

    (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

    (c) The contribution was provided directly to me by some other person who certified (a), (b) or (c) and I have not modified it.

    (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.

This is my commit message

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:

$ 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!

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

How to Contribute to GitHub Workflows

To contribute to the GitHub workflows in this repository, please follow these steps:

  1. Identify a specific area where you would like to contribute, such as adding a new workflow or improving an existing one.
  2. Fork the repository.
  3. Clone the repository to your local machine.
  4. Create a new branch for your changes: git checkout -b <branch-name>
  5. Make your changes to the GitHub workflows.
  6. Test your changes to ensure that they work as expected.
  7. Document any new workflows that you add or changes that you make to existing ones.
  8. Commit your changes: git commit -ams 'Add some feature'
  9. Push your changes to your fork: git push origin <branch-name>
  10. Submit a pull request to the main repository.

Running GitHub Workflows in Your Personal Fork

To run the GitHub workflows in your personal fork of this repository, you will need to set up some environment variables and secrets. These settings are necessary for the workflows to run successfully.

Required Environment Variables

The following environment variables are required for the GitHub workflows in this repository:

  • GITHUB_TOKEN: This is a personal access token that allows the workflow to authenticate with GitHub. You can create a personal access token by following these instructions.

Required Secrets

The following secrets are required for the GitHub workflows in this repository:

  • DOCKER_USERNAME: This is the username for your Docker Hub account. You can create a Docker Hub account by following these instructions.
  • DOCKER_PASSWORD: This is the password for your Docker Hub account.

Setting Up Environment Variables and Secrets

To set up the required environment variables and secrets in your personal fork of this repository, follow these steps:

  1. Navigate to your personal fork of this repository on GitHub.
  2. Click on the "Settings" tab.
  3. Click on the "Secrets" menu item.
  4. Click on the "New repository secret" button.
  5. Enter the name of the secret (e.g., DOCKER_USERNAME).
  6. Enter the value of the secret (e.g., your Docker Hub username).
  7. Repeat steps 5-6 for the DOCKER_PASSWORD secret.
  8. Navigate to the "Actions" tab in your personal fork of the repository.
  9. Enable GitHub Actions for your fork by clicking on the "I understand my workflows, go ahead and enable them" button.
  10. Update the env section of the GitHub workflows to include your own values for the required environment variables and secrets.

Workflow permissions

  1. Navigate to your personal fork of this repository on GitHub.
  2. Click on the "Settings" tab.
  3. Click on the "Actions" menu item and select General.
  4. Scroll down to Workflow permissions section and select Read and write permissions

That's it! With the required environment variables and secrets set up in your personal fork, you should be able to run the GitHub workflows successfully.

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.

Code of Conduct

This project has adopted the Contributor Covenant Code of Conduct