Skip to content

Latest commit

 

History

History
103 lines (65 loc) · 6.82 KB

CONTRIBUTING.md

File metadata and controls

103 lines (65 loc) · 6.82 KB
Raw

Contributing to Flutter Templates

First off, thanks for taking the time to contribute! 🎉

Read our Code of Conduct to keep our community approachable and respectable.

Please make sure to read the relevant section before making your contribution. It will make it much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:

  • Star the project
  • Tweet about it
  • Refer to this project in your project's readme
  • Mention the project at local meetups and tell your friends/colleagues

Code of Conduct

This project and everyone participating in it is governed by the Flutter Templates Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to dev@nimblehq.co.

What should I know before I get started?

Get to know Mason

The Flutter templates use Mason as the primary tool for generating a new Flutter project. Take some time to become familiar with it.

Flutter templates structure

The repository contains three main files/directories:

  • The bricks directory contains the primary development, which is the "template" brick.
  • The sample directory contains a sample Flutter project that was automatically generated by the CI workflow. This ensures that the project is not broken during development.
  • The mason.yaml file lists all the bricks in the repository.

I Have a Question

Before you ask a question, it is best to search for existing Issues that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.

If you still feel the need to ask a question and need clarification, we recommend the following:

  • Open a Discussion.
  • Provide as much context as you can about what you're running into.
  • Provide the project version and platform info (OS, Flutter version, etc), depending on what seems relevant.

We will then analyze and plan for it.

I Want To Contribute

Reporting Bugs

Before Submitting a Bug Report

A good bug report shouldn't leave others needing to chase you up for more information. Therefore, we ask you to investigate carefully, collect information, and describe the issue in detail in your report. Please complete the following steps in advance to help us fix any potential bug as fast as possible.

  • Make sure that you are using the latest version.
  • Determine if your bug is really a bug and not an error on your side, e.g., using incompatible environment components/versions (Make sure that you have read the README. If you are looking for support, you might want to check this section).
  • To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the bug tracker.
  • Also, make sure to search the internet (including Stack Overflow) to see if users outside of the GitHub community have discussed the issue.
  • Collect information about the bug:
    • Stack trace (Traceback)
    • OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
    • Flutter's doctor (if the generated project runs failed)
    • Possibly your input and the output
    • Can you reliably reproduce the issue? And can you also reproduce it with older versions?

How Do I Submit a Good Bug Report?

You must never report security related issues, vulnerabilities, or bugs including sensitive information to the issue tracker, or elsewhere in public. Instead sensitive bugs must be sent by email to dev@nimblehq.co.

We use GitHub issues to track bugs and errors. If you run into an issue with the project:

  • Open a Bug Report's Issue.
  • Explain the behavior you would expect and the actual behavior.
  • Please provide as much context as possible and describe the reproduction steps that someone else can follow to recreate the issue on their own. This usually includes your code. For good bug reports, you should isolate the problem and create a reduced test case.
  • Provide the information you collected in the previous section.

Your First Code Contribution

If you're not sure where to start contributing to Flutter Templates, browse through the Issues and choose one that suits you best.

Pull Requests

Please follow these steps to have your contribution considered by the maintainers:

  • Follow the Flutter convention & style guides.
  • After submitting your pull request, verify that all status checks are passing
    What if the status checks are failing?If a status check is failing, and you believe that the failure is unrelated to your change, please leave a comment on the pull request explaining why you believe the failure is unrelated. If we conclude that the failure was a false positive, then we will open an issue to track that problem with our status check suite.

While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.

Style guides

Git Branch Management

Check out our Branch Management for more details about the branch formatting, naming, etc.

Git Commit Messages

Check out our Committing Code for more details about the commit message formatting, structure, etc.

Code Conventions

Check out our Flutter convention for more details about the code convention and style guides.