Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (57 loc) · 2.52 KB

CONTRIBUTING.md

File metadata and controls

82 lines (57 loc) · 2.52 KB
Raw

CONTRIBUTING to Widgets in Flutter

Thank you for your interest in contributing to Widgets in Flutter! This project aims to showcase Flutter widgets in an interactive and educational way. We welcome contributions from developers of all skill levels.

Getting Started

Setting Up Your Environment

  1. Fork the repository to your GitHub account
  2. Clone your fork locally: 
    git clone https://github.com/CerberusPRogrammer/widgets_in_flutter.git
  3. Set up your environment: 
    cd widgets_in_flutter
flutter pub get
  4. Create a new branch for your feature or fix: 
    git checkout -b feature/your-feature-name

How to Contribute

Adding New Widgets

If you want to add a new widget demonstration:

  1. Create a new widget file in the appropriate directory
  2. Add proper documentation comments explaining the widget's functionality
  3. Include a variety of examples showcasing different configurations
  4. Update any navigation or index files to include your new widget

Improving Existing Widgets

For improving existing widget demonstrations:

  1. Enhance code documentation
  2. Add additional examples to showcase more use cases
  3. Fix any display or functional issues
  4. Optimize performance where possible

Code Style

Please follow these guidelines:

  • Use the standard Flutter/Dart code style
  • Run flutter analyze before submitting to catch any issues
  • Include meaningful comments where necessary
  • Keep widgets self-contained when possible
  • Use descriptive variable and function names

Pull Request Process

  1. Ensure your code follows our style guidelines
  2. Add appropriate tests for your changes
  3. Update documentation as needed
  4. Submit a pull request with a clear description of your changes
  5. Link any related issues in your pull request description

Bug Reports and Feature Requests

  • Use the GitHub Issues templates to report bugs or request features
  • Be specific about steps to reproduce bugs
  • For feature requests, explain why the feature would benefit the project

Code of Conduct

This project adheres to our Code of Conduct. By participating, you are expected to uphold this code.

Community

  • Join discussions in project issues
  • Share the project with fellow Flutter developers
  • Help answer questions from new contributors

Contact

If you have questions that aren't addressed here, please contact the maintainer at sazardev@gmail.com.

Thank you for contributing to making Flutter widgets more accessible and understandable for everyone!