| 1 | # Contributing
|
| 2 |
|
| 3 | Thank you for looking into contributing to`daily-js`! We welcome your contributions toward making [Daily](https://www.daily.co) the easiest real-time video API for developers to use in their products.
|
| 4 |
|
| 5 | **Before contributing:**
|
| 6 |
|
| 7 | - [Read our code of conduct](#read-our-code-of-conduct)
|
| 8 |
|
| 9 | **How to contribute:**
|
| 10 |
|
| 11 | - [Open or claim an issue](#open-or-claim-an-issue)
|
| 12 | - [Open a pull request](#open-a-pull-request)
|
| 13 |
|
| 14 | ## Before contributing
|
| 15 |
|
| 16 | ### Read our code of conduct
|
| 17 |
|
| 18 | We use the [Contributor Covenant](https://www.contributor-covenant.org/) for our Code of Conduct. Before contributing, [please read it](CODE_OF_CONDUCT.md).
|
| 19 |
|
| 20 | ## How to contribute
|
| 21 |
|
| 22 | ### Open or claim an issue
|
| 23 |
|
| 24 | #### Open an issue
|
| 25 |
|
| 26 | Today we work off two main issue templates: _bug reports_ and _feature requests_.
|
| 27 |
|
| 28 | _Bug reports_
|
| 29 |
|
| 30 | Before creating a new bug report, please do two things:
|
| 31 |
|
| 32 | 1. If you want to report a bug you experienced while on a Daily call, try out these [troubleshooting tips](https://help.daily.co/en/articles/2303117-top-troubleshooting-tips) to see if that takes care of the bug.
|
| 33 | 2. If you're still seeing the error, check to see if somebody else has [already filed the issue](https://github.com/daily-co/daily-js/issues) before creating a new one.
|
| 34 |
|
| 35 | If you've done those two things and need to create an issue, we'll ask you to tell us:
|
| 36 |
|
| 37 | - What you expected to happen
|
| 38 | - What actually happened
|
| 39 | - Steps to reproduce the error
|
| 40 | - Screenshots that illustrate where and what we should be looking for when we reproduce
|
| 41 | - System information, like your device, OS, and browser
|
| 42 | - Any additional context that you think could help us work through this
|
| 43 |
|
| 44 | _Feature requests_
|
| 45 |
|
| 46 | We're always happy to hear about new ways you'd like to use Daily. If you'd like a feature that we don't have yet, we'll ask you to let us know:
|
| 47 |
|
| 48 | - If the feature will help you solve a particular problem
|
| 49 | - Alternative solutions you've considered
|
| 50 | - Any additional context that might help us understand this ask
|
| 51 |
|
| 52 | #### Claim an issue
|
| 53 |
|
| 54 | 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.
|
| 55 |
|
| 56 | ### Open a pull request
|
| 57 |
|
| 58 | - If it's been a minute or if you haven't yet cloned, forked, or branched a repository, GitHub has some [docs to help](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests).
|
| 59 | - When creating commit messages and pull request titles, please follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard.
|
| 60 | - Note that the `daily-js` repo is a public-facing mirror of an internal Daily repo, so when a pull request contribution is accepted, the pull request won't be merged in the tradtional way. But never fear! Your contributed commits _will_ appear, appropriately attributed to you, in the `daily-js` repo.
|