Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
107 lines (67 loc) · 4.88 KB

CONTRIBUTING.md

File metadata and controls

107 lines (67 loc) · 4.88 KB

Contributing to Firebase Dart Admin Auth SDK

Thank you for considering contributing to the FirebaseDart Authentication SDK, a Dart implementation for Firebase Authentication services designed to work out of the box for any application that wants to use Firebase and dart together.

Quicklinks

Code of Conduct

By participating and contributing to Firebase Dart Admin Auth SDK, you are expected to uphold our Code of Conduct.

What We Are Looking For

We welcome contributions in various forms, such as:

  • Bug reports and fixes
  • Feature requests and implementations
  • Documentation improvements
  • Feedback on the SDK's performance and design

How to Contribute

Due to the significant time required to review pull requests, we generally only accept and review pull requests from our internal community and network. However, we welcome bug reports and documentation contributions from everyone.

If you wish to join our community or officially contribute to the repository, please join our Discord community or subscribe to our mailing list.

Submitting a Bug Report

  1. Check Existing Issues: Before submitting a new bug report, please check if the issue already exists in our GitHub Issues.

  2. Create a New Issue: If the bug is not listed, create a new issue. Provide a detailed description, steps to reproduce, and any relevant screenshots or logs.

Submitting a Documentation Report

  1. Check Existing Documentation: Ensure the documentation report or suggestion is not already covered.

  2. Create a New Issue: Open a new issue and select the "Documentation" template. Clearly describe the documentation improvement or error.

Getting Started

Set up your environment by:

  1. Forking and cloning the project repository.
  2. Installing Dart and any required dependencies.
  3. Following the setup instructions to prepare your development environment.

Pull Request Guidelines

Ensure your pull request adheres to the following:

  1. Aligns with the project's code style and best practices.
  2. Passes all existing tests and any new tests related to your changes.
  3. Updates or adds documentation as needed.
  4. Describes the changes made and the reasoning behind them.

Reporting Bugs

When reporting bugs, include:

  • Clear and descriptive title.
  • Step-by-step reproduction instructions.
  • Expected and actual behavior.
  • Environment details (OS, Dart version, etc.).

Feature Requests

We encourage feature requests that enhance the SDK. Please:

  • Feature Request and enhcancements can be submitted through the Freshdesk subscription console.
  • Explain how it aligns with the SDK's goals.
  • Discuss potential implementation and impact.

Improving Documentation

Your contributions to improve or clarify documentation are always welcome. Whether it's typo corrections, additional examples, or clearer explanations, your help is invaluable.

Available Versions

  1. Main - Stable Version: Usually one release a month. This version attempts to keep stability without introducing breaking changes.
  2. Sample Apps - FrontEnd Version: The sample apps are provided in various frontend languages in order to allow maximum flexibility with your frontend implementation with the Dart backend. Note that new features are first tested in the sample apps before being released in the mainline branch. Use only as a guide for your frontend/backend implementation of Dart.

Community

Join the discussion on issues, contribute to pull requests, or reach out through our Join our Discord channel for more informal discussions. Your input is crucial to the project's success.

Licensing

All Firebase Dart Admin Auth SDK packages are licensed under BSD-3, except for the services packages, which uses the ELv2 license, and are licensed from third party software Aortem Inc. In short, this means that you can, without limitation, use any of the client packages in your app as long as you do not offer the SDK's or services as a cloud service to 3rd parties (this is typically only relevant for cloud service providers). See the LICENSE file for more details.

Acknowledgments

  • Inspired by the simplicity of Firebase_Dart.
  • Thanks to the Dart community for continuous support and inspiration.

We would like to extend our gratitude to all the developers and contributors who have made this Firebase Dart SDK possible and continue to support its growth.