You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
25 lines
1.2 KiB
Markdown
25 lines
1.2 KiB
Markdown
|
|
# Tangheem
|
|
|
|
A Flutter application to read Quran and view Tangheem on it.
|
|
|
|
## Flutter Dependency
|
|
|
|
|
|
There are some important information regarding Project
|
|
|
|
- Based on flutter v2.0 or above
|
|
|
|
## Coding Guide Lines:
|
|
- Set android studio 200 as words per line (Setting>Editor>Coding style>Dart) to avoid file format conflicts among all team members.
|
|
- Must format file whenever perform git push
|
|
- Folder naming should be lowercase e.g. folder_name
|
|
- File naming should be lowercase e.g. file_name
|
|
- Class naming should be first letter uppercase e.g. ClassName
|
|
- Function name should be very clear to understand and should be camelCase e.g. funtionName
|
|
- Variable names should be very clear which conveys the proper meaning of its use, to make code reading fast and easy to read by everyone.
|
|
- Variable naming should be camelCase e.g. variableName;
|
|
- Define variable scope if it only uses in a limited class or function make it private to avoid conflicts.
|
|
- Make a personal git change list if you are working on a file for test for your own purposes. (to avoid that test changes when you git push)
|
|
- avoid using too many packages if only a few functionalities required (Copy that separate code from the package file and then use this code)
|