Skip to content

Latest commit

 

History

History
72 lines (42 loc) · 3.1 KB

CONTRIBUTING.md

File metadata and controls

72 lines (42 loc) · 3.1 KB
Raw

Contributing

Thank you for looking into contributing to daily-demos! We want these projects to help people experiment with Daily more quickly. We especially welcome any contributions that help us make existing demos easier to understand, improve demos' instructions and descriptions, and we're especially excited about any new demos that highlight unique ways to use the Daily API.

Before contributing:

How to contribute:

Before contributing

Run demo locally

Please follow the instructions in README.md.

Read our code of conduct

We use the Contributor Covenant for our Code of Conduct. Before contributing, please read it.

How to contribute

Open or claim an issue

Open an issue

Today we work off two main issue templates: bug reports and demo/feature requests.

Bug reports

Before creating a new bug report, please do two things:

  1. If you want to report a bug you experienced while on a Daily call, try out these troubleshooting tips to see if that takes care of the bug.
  2. If you're still seeing the error, check to see if somebody else has already filed the issue before creating a new one.

If you've done those two things and need to create an issue, we'll ask you to tell us:

  • What you expected to happen
  • What actually happened
  • Steps to reproduce the error
  • Screenshots that illustrate where and what we should be looking for when we reproduce
  • System information, like your device, OS, and browser
  • Any additional context that you think could help us work through this

Demo/feature requests

We're always happy to hear about new ways you'd like to use Daily. If you'd like a demo that we don't have yet, we'll ask you to let us know:

  • If the demo will help you solve a particular problem
  • Alternative solutions you've considered
  • Any additional context that might help us understand this ask

Claim an issue

All issues labeled good-first-issue are up for grabs. If you'd like to tackle an existing issue, feel free to assign yourself, and please leave a comment letting everyone know that you're on it.

Open a pull request

  • If it's been a minute or if you haven't yet cloned, forked, or branched a repository, GitHub has some docs to help.
  • When creating commit messages and pull request titles, please follow the conventional commits standard.

Contribute a new demo project

If you've built a project on Daily that you want to share with other developers, we'd be more than happy to help spread the word.

To add a new demo project:

Open a PR in awesome-daily and add a link to your project.