Skip to content

Latest commit

 

History

History
27 lines (16 loc) · 1.82 KB

CONTRIBUTING.md

File metadata and controls

27 lines (16 loc) · 1.82 KB

Contributing to the Twilio Firebase Extensions

About the project

This project is a collection of different Firebase Extensions within one repository. You can find each extension under the top level project directories.

Before you contribute

We welcome everyone to contribute to this project. If you don't know what to work on, check our open Issues and specifically for the Help Wanted and Good First Issue labels.

If you want to work on one of those open issues, please comment on the issue to let us know that you are working on it. Similarly if you can't work on it anymore, please let us know.

If you are planning to contribute something that does not have an open issue yet, please open an issue for it before you start working on it. This way we can help you find a good solution.

Contributing

  1. Perform changes
  2. Make sure tests pass by running npm test (once a test suite is in place)
  3. Stage the files you changed by running git add with the files you changed
  4. Run git commit to kick off validation and enter your commit message. We are using conventional commits for this project. When you run npm run cm it will trigger commitizen to assist you with your commit message
  5. Submit a Pull Request

Working on your first Pull Request? You can learn how from this free series How to Contribute to an Open Source Project on GitHub.

Licensing

All third party contributors acknowledge that any contributions they provide will be made under the same open source license that the open source project is provided under.