Thank you for considering contributing to flutter_onscreen_keyboard! 🎉
Your support helps make this package better for everyone.
- Getting Started
- How to Contribute
- Coding Guidelines
- Running the Example
- Submitting a Pull Request
- Reporting Issues
- Code of Conduct
- Fork the repository: flutter_onscreen_keyboard
- Clone your fork:
git clone https://github.com/YOUR_USERNAME/flutter_onscreen_keyboard.git
cd flutter_onscreen_keyboard/packages/flutter_onscreen_keyboard- Install Flutter and dependencies:
fvm install
flutter pub get- 💡 Suggest a new feature
- 🐛 Report a bug
- 🛠️ Submit a fix or enhancement
- 🧪 Improve or add examples
- 🧹 Refactor code or improve documentation
- Follow Flutter's style guide.
- Write clear, concise commit messages.
- Use meaningful names for classes, variables, and methods.
- Add documentation comments (
///) to public APIs. - Format your code using:
dart format .- Run static analysis before committing:
flutter analyzeYou can test your changes by running the included example app:
cd example
flutter runMake sure the keyboard behavior works properly with the demo.
- Create a new branch:
git checkout -b feature/your-feature-name- Make your changes and commit them:
git commit -m "fix: your description"- Push to your fork and create a pull request from GitHub's UI.
If you encounter any bugs or want to request a feature, open a GitHub issue:
Please include:
- A clear title and description.
- Reproduction steps or a minimal code example.
- Flutter/Dart versions, OS info, and any relevant logs.
Be respectful and inclusive in all discussions. By contributing, you agree to follow the Contributor Covenant.
Thank you again for your interest in improving flutter_onscreen_keyboard! 🌟