CONTRIBUTING.md

Welcome to Miro's contributing guide

Thank you for investing your time in contributing to Miro! Any contribution you make will be reviewed by our team.

Read our Code of Conduct to keep our community approachable and respectable.

In this guide you will get an overview of the contribution workflow from opening an issue, creating a PR, reviewing, and merging the PR.

New contributor guide

Within Miro's GitHub, you'll find many different projects you can contribute to. From our repository of app examples, to our other open source projects, we invite and encourage you to add your contributions to further better Miro.

If you're new on contributing to open source projects, visit the links below to get started.

• Finding ways to contribute to open source on GitHub
• Set up Git
• GitHub flow
• Collaborating with pull requests

Issues

Create a new issue

If you spot a problem within a repository, search if an issue already exists. If a related issue doesn't exist, you can open a new issue.

Please make sure any added issues are

• Descriptive
• Thoughtful
• Organized

We recommend adding as many relevant links, minimal reproductions of the issue, and other materials that will help our team solve the issue fast.

Solve an issue

If you're interested in solving an issue in a repository, start by scanning through it's exisiting issues to find one that you're interested in working on. If you find an issue to work on, you are welcome to open a PR with a fix.

Make Changes

Make changes locally

1. Fork the repository so that you can make your changes without affecting the original project until you're ready to merge them.

• Using GitHub Desktop:

  • Getting started with GitHub Desktop will guide you through setting up Desktop.
  • Once Desktop is set up, you can use it to fork the repo!

• GitHub Codespaces:

  • Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.

2. Create a working branch and start with your changes!

Commit your update

Commit your changes once you are happy with them. See Atom's contributing guide to know how to use emoji for commit messages!

Once your changes are ready, don't forget to self-review your code to double check that your changes are ready to be added.

Pull Request

When you're finished with the changes, create a pull request, also known as a PR.

• Make sure your description is organized, clear, and concise on the changes you're proposing.
• Don't forget to link PR to issue if you are solving one.
• Enable the checkbox to allow maintainer edits so the branch can be updated for a merge. Once you submit your PR, a Miro team member will review your proposal. We may ask questions or request for additional information.
• We may ask for changes to be made before a PR can be merged, either using suggested changes or pull request comments. You can apply suggested changes directly through the UI. You can make any other changes in your fork, then commit them to your branch.
• As you update your PR and apply changes, mark each conversation as resolved.
• If you run into any merge issues, checkout this git tutorial to help you resolve merge conflicts and other issues.

If you'd like to continue working on your changes while still allowing the Miro team to review your changes, you can also open a draft PR.

Your PR is merged!

Congratulations! The Miro team is happy to have you contribute.

Once your PR is merged, your contributions will be publicly visible on the relevant repository.

Now that you are part of the Miro community, make sure to join us in our Discord as well!