|
1 |
| -# How to Contribute |
| 1 | +# Contributing |
2 | 2 |
|
3 |
| -We'd love to accept your patches and contributions to this project. There are |
4 |
| -just a few small guidelines you need to follow. |
| 3 | +It's great to receive contributions from the community! If you'd like to contribute to this project, make sure to review and follow the guidelines below. |
5 | 4 |
|
6 | 5 | ## Contributor License Agreement
|
7 | 6 |
|
8 | 7 | Contributions to this project must be accompanied by a Contributor License
|
9 | 8 | Agreement. You (or your employer) retain the copyright to your contribution;
|
10 |
| -this simply gives us permission to use and redistribute your contributions as |
11 |
| -part of the project. Head over to <https://cla.developers.google.com/> to see |
| 9 | +this agreement simply gives us permission to use and redistribute your contributions as |
| 10 | +part of the project. Head over to [https://cla.developers.google.com](https://cla.developers.google.com) to see |
12 | 11 | your current agreements on file or to sign a new one.
|
13 | 12 |
|
14 | 13 | You generally only need to submit a CLA once, so if you've already submitted one
|
15 | 14 | (even if it was for a different project), you probably don't need to do it
|
16 | 15 | again.
|
17 | 16 |
|
18 |
| -## Code reviews |
| 17 | +## Code and copy reviews |
19 | 18 |
|
20 | 19 | All submissions, including submissions by project members, require review. We
|
21 | 20 | use GitHub pull requests for this purpose. Consult
|
22 | 21 | [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more
|
23 | 22 | information on using pull requests.
|
24 | 23 |
|
25 |
| -## Community Guidelines |
| 24 | +## Community guidelines |
26 | 25 |
|
27 | 26 | This project follows [Google's Open Source Community
|
28 | 27 | Guidelines](https://opensource.google.com/conduct/).
|
| 28 | + |
| 29 | +## Report an issue |
| 30 | + |
| 31 | +Report all issues through GitHub Issues using the [Report a Bug](https://github.com/firebase/extensions/issues/new?template=bug.md) template. |
| 32 | + |
| 33 | +To help resolve your issue as quickly as possible, read the template and provide all the requested information. |
| 34 | + |
| 35 | +## File a feature request |
| 36 | + |
| 37 | +We welcome all feature requests, whether it's to add new functionality to an existing extension or to offer an [idea for a brand new extension](https://firebase.google.com/support/troubleshooter/report/features/). |
| 38 | + |
| 39 | +Here's how to submit a feature request for an existing extension: |
| 40 | + |
| 41 | +1. File your feature request through GitHub Issues using the [Feature Request template](https://github.com/firebase/extensions/issues/new?template=fr.md). |
| 42 | + |
| 43 | +1. File a new [Firebase support request](https://firebase.google.com/support/troubleshooter/report/features/) via the Firebase website. Make sure to reference your feature request's GitHub Issue in the support ticket. |
| 44 | + |
| 45 | +## Create a pull request |
| 46 | + |
| 47 | +When making pull requests to the repository, make sure to follow these guidelines for both bug fixes and new features: |
| 48 | + |
| 49 | +- Before creating a pull request, file a GitHub Issue so that maintainers and the community can discuss the problem and potential solutions before you spend time on an implementation. |
| 50 | +- In your PR's description, link to any related issues or pull requests to give reviewers the full context of your change. |
| 51 | +- For commit messages, follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) format. |
| 52 | + - For example, if you update documentation for a specific extension, your commit message might be: `docs(extension-name) updated installation documentation`. |
| 53 | +- For your PR to be merged: |
| 54 | + |
| 55 | + - You must sign the [Google Contributor License Agreement](https://cla.developers.google.com/clas). |
| 56 | + - All tests must pass. |
| 57 | + |
| 58 | +### Features |
| 59 | + |
| 60 | +Before creating pull requests for new features, first file a GitHub Issue describing the reasoning and motivation for the feature. This gives maintainers and the community the opportunity to provide feedback on your idea before implementing it. |
0 commit comments