Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (61 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

86 lines (61 loc) · 2.28 KB
Raw

Contributing to Password Check

Thank you for your interest in contributing to Password Check! 🎉

🚀 Quick Start

  1. Fork the repository
  2. Clone your fork: git clone https://github.com/YOUR_USERNAME/Password-Check.git
  3. Create a feature branch: git checkout -b feature/your-feature-name
  4. Make your changes
  5. Test your changes: flutter test
  6. Commit your changes: git commit -m "Add your feature"
  7. Push to your fork: git push origin feature/your-feature-name
  8. Create a Pull Request

📋 Guidelines

Code Style

  • Follow Dart/Flutter conventions
  • Use meaningful variable names
  • Add comments for complex logic
  • Keep functions small and focused

Testing

  • Add tests for new features
  • Ensure all tests pass: flutter test
  • Maintain test coverage above 90%

Documentation

  • Update README.md for new features
  • Add examples for new APIs
  • Update CHANGELOG.md for significant changes

🐛 Bug Reports

When reporting bugs, please include:

  • Flutter/Dart version
  • Steps to reproduce
  • Expected vs actual behavior
  • Screenshots (if applicable)

💡 Feature Requests

For new features, please:

  • Check existing issues first
  • Describe the use case
  • Explain the benefits
  • Consider implementation complexity

📝 Pull Request Process

  1. Update documentation if needed
  2. Add tests for new functionality
  3. Ensure all tests pass
  4. Update CHANGELOG.md
  5. Request review from maintainers

🤝 Code of Conduct

  • Be respectful and inclusive
  • Focus on constructive feedback
  • Help others learn and grow
  • Follow our Code of Conduct

📞 Questions?

🆘 Support

Thank you for contributing to Password Check! 🙏

Made with ❤️ by the youngDevs