Skip to content

Contributing

Chuck edited this page Oct 1, 2021 · 3 revisions

Contributing Guidelines

Thanks for taking the time to contribute!

The following is a set of guidelines for contributing to the Godot Firebase Plugin. Please try to adhere to them as best as possible.

Getting Started

GodotFirebase is built on top of Godot. You will need to have Godot installed to use this plugin.

Issues

Please ensure the bug was not already reported by searching on GitHub under issues. If you're unable to find an open issue addressing the bug, open a new issue.

Please pay attention to the following points while opening an issue.

Write detailed information

Detailed information is very helpful when trying to understand the issue

For example:

  • How to reproduce the issue, step-by-step.
  • The expected behavior (or what is wrong).
  • Screenshots for GUI issues.
  • The version of Godot
  • Any other information you can provide

Pull Requests

Pull Requests are always welcome.

  • Ensure the PR description clearly describes the problem and solution. It should include:
    • The relevant issue number, if applicable.
    • Any new features that have been added
    • Any relevant tests that have been run

Discussions

Discussions are great for when you have a question or want to talk to us about the plugin. While we do try to monitor them, most of the discussions have moved over to our Discord.