Contribution Guidelines & Development Practices

Contribution to the project can be made if you have some improvements for the project or if you find some bugs. You can contribute to the project by reporting issues, forking it, modifying the code and making a pull request to the repository.

Please make sure you specify the commit type when opening pull requests:

feat: The new feature you're proposing

fix: A bug fix in the project

style: Feature and updates related to UI improvements and styling

test: Everything related to testing

docs: Everything related to documentation

refactor: Regular code refactoring and maintenance

Development Practices

• Use Flutter 2.2.2 or later for development (as on 07-08-2021)

Flutter 2.2.2 • channel stable • https://github.com/flutter/flutter.git
Framework • revision d79295af24 (8 weeks ago) • 2021-06-11 08:56:01 -0700
Engine • revision 91c9fc8fe0
Tools • Dart 2.13.3

• Follow Stacked Architecture to learn about the foundation of practices used in the project.
• The file naming convention used in the project is Snakecase naming convention and must be followed without fail.

Example -

File names : services_info.dart, dev_api_service.dart, home_view.dart
Folder names : api, disk_explorer, smart_widgets

• The colors, dimensions and any constant used for UI/UX design can be defined in its respective theme file in /lib/ui/shared/shared_styles.dart.
• Document the functions, classes and any logic implemented by you for every file required.
• The practices mentioned in this link must be followed without fail.

Community

You may join the gsoc-rutorrent channel of CCExtractor community through slack and propose improvements to the project.

• CCExtractor Development on Slack