Skip to content

Latest commit

 

History

History
64 lines (35 loc) · 3.17 KB

CONTRIBUTING.md

File metadata and controls

64 lines (35 loc) · 3.17 KB
Raw

Contributing

We want to make contributing to this project as easy and transparent as possible and we are grateful for, any contributions made by the community.

Reporting Issues and Asking Questions

Before opening an issue, please search the issue tracker to make sure your issue hasn't already been reported.

Bugs and Improvements

We use the issue tracker to keep track of bugs and improvements to Flutter Starter itself, its examples, and the documentation. We encourage you to open issues to discuss improvements, architecture, theory, internal implementation, etc. If a topic has been discussed before, we will ask you to join the previous discussion.

Development

Visit the issue tracker to find a list of open issues that need attention.

Building

Go to Flutter Docs and install Flutter in your system.

Go to our github repo and create a template.

https://github.com/GeekyAnts/flutter-starter/generate

To run the project, run:

bash run_script.sh

Add Test Files

To add test files go to each folder shared, api-sdk and app there will be test folder add the test files there and write the test cases.

To see how to write test cases check out the official documents.

Docs

Improvements to the documentation are always welcome. You can find them in the flutter-starter.github.io repository. We use Docusaurus to build our documentation website. The website is published automatically whenever the master branch is updated.

Examples

Flutter Starter comes with HackerNews App, GithubRepo List App and Weather App as examples to demonstrate various concepts and best practices.

When adding a new example, please adhere to the style and format of the existing examples, and try to reuse as much code as possible.

Sending a Pull Request

For non-trivial changes, please open an issue with a proposal for a new feature or refactoring before starting on the work. We don't want you to waste your efforts on a pull request that we won't want to accept.

In general, the contribution workflow looks like this:

  • Open a new issue in the Issue tracker.
  • Fork the repo.
  • Create a new feature branch based off the master branch.
  • Make sure all tests pass and there are no linting errors.
  • Submit a pull request, referencing any issues it addresses.

Please try to keep your pull request focused in scope and avoid including unrelated commits.

After you have submitted your pull request, we'll try to get back to you as soon as possible. We may suggest some changes or improvements.

Thank you for contributing!