Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
58 lines (38 loc) · 1.74 KB

CONTRIBUTING.md

File metadata and controls

58 lines (38 loc) · 1.74 KB
Raw

Contributing to SMF Flutter CLI

Thank you for your interest in contributing to SMF Flutter CLI! This document provides guidelines and information for contributors.

Code of Conduct

This project and everyone participating in it is governed by our Code of Conduct. By participating, you are expected to uphold this code.

How Can I Contribute?

Reporting Bugs

  • Use the GitHub issue tracker
  • Include detailed steps to reproduce the bug
  • Provide your environment details (OS, Flutter version, etc.)
  • Include error messages and stack traces

Suggesting Enhancements

  • Use the GitHub issue tracker with the "enhancement" label
  • Describe the feature and its benefits
  • Provide use cases and examples

Submitting Code Changes

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests for new functionality
  5. Ensure all tests pass
  6. Commit your changes (git commit -m 'Add amazing feature')
  7. Push to the branch (git push origin feature/amazing-feature)
  8. Open a Pull Request

Development Setup

  1. Clone the repository
  2. Install dependencies: melos bootstrap
  3. Run tests: melos test

Code Style

  • Follow Dart style guide
  • Use very_good_analysis for linting
  • Write meaningful commit messages
  • Add tests for new functionality

Copyright and Licensing

By contributing to this project, you agree that your contributions will be licensed under the Apache License, Version 2.0.

When submitting code, please ensure you have the right to license your contributions under the Apache License.

Questions?

If you have questions about contributing, please contact us at support@saymyframe.com or open an issue on GitHub.

Thank you for contributing to SMF Flutter CLI!