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.
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.
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.
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.
Most of the changes you will make in this repository will be added to the examples folder. Here you'll different app examples located under their own directories. To add a new example, start by adding a new folder with all the necessary files to run your app.
Don't forget to add a descriptive README file so others will know what to expect when looking at your example.
Some important things to mention in your README might include:
- Getting started
- Folder strucutre
- About the app
- How to get in contact with you for support
Before making changes, read the tooling section to make sure you have the right tools installed.
- Fork the repository.
-
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!
-
Using the command line:
- Fork the repo so that you can make your changes without affecting the original project until you're ready to merge them.
-
GitHub Codespaces:
- Fork, edit, and preview using GitHub Codespaces without having to install and run the project locally.
- Create a working branch and start with your changes!
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 chagnes are ready to be added.
When you're finished with the changes, create a pull request, also known as a PR.
- 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.
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!
Please look at README.template.md for an example of how your README should look in order to contribute to App Examples.
If you want to add an app into our App Examples folder please make sure the README it follows the same structure as our other app examples. You can take a look at Calendar app README for example. In order for your app example and PR to get approved, please make sure you have the following components in your README:
- App title section with simple 1 line description of what you app example does.
- 15-60 second App Demo section. The shorter the better.
- Table of contents section
- Included Features section, which details which Miro SDK or API methods are used in the example.
- Tools and Technologies section, which details which any technologies you are using, i.e. Node.js, React.
- Prerequisistes section, which details any dependencies or additional CLIs that may need to be installed before running the app.
- Run the app section. This section should go over how to run the app locally. Please be as descriptive as possible to ensure the developer can install and configure your app easily, even if it is their first time using these tools and technologies.
- Folder Structure section. This section outlines what each file is for in the app so a developer can quickly understand the file layout of your app.
- Contributing section. Here you can just link to Miro's contributing guide.
- License section. This should indicate what license you want to use.