Skip to content

Latest commit

 

History

History
47 lines (25 loc) · 1.89 KB

CONTRIBUTING.md

File metadata and controls

47 lines (25 loc) · 1.89 KB
Raw

Contribution Guildelines

Please follow these steps if you wish to contribute to the project

  1. Go through the Issues to see if, what you want is already in discussion.

  2. Open a new Issue if you do not find what you need. Describe the bug, feature request, problems, additions you might want or anything clearly in the Issue message.

  3. Mention in the Issue that you want to work on it.

  4. Wait for the approval from the Maintainers of this project before startig to work on it.

  5. Create a pull request after making the changes and mention the Issue number that your pull request is related to.

  6. Make the required changes if the reviewer asks for them.

  7. That's it! Your pull request will be merged once everything seems okay.

This project is a Flutter application.

A few resources to get you started if this is your first Flutter project:

For help getting started with Flutter, view flutter online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.

Special Guidelines for contributing to this Project

  • The dependencies and assets will all be included in the pubspec.yaml file.

  • All the main files related to the project are contained in the lib folder.

  • Global widgets should be included in the lib/widgets folder.

  • Providers should be included in the lib/providers folder.

  • Models should be included in the lib/models folder.

  • All the pages of the app should be included in the lib/pages folder with $PAGE_NAME.dart.

  • Add all the necessary Android and IOS permissions in the android and ios folders, respectively.

  • For using external resources, add them to the assets folder as mentioned in the comments in pubspec.yaml file.