Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

33 lines (24 loc) · 1.57 KB
Raw

Contributing to Tenor Dart

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue, assessing changes, and helping you finalize your pull requests. These are guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

How Can You Contribute?

  • Pick up any issue marked with "good first issue"
  • Propose any feature, enhancement
  • Report a bug
  • Fix a bug
  • Write and improve some documentation
  • Send in a Pull Request 🙏

Creating a Pull Request

Before creating a pull request please:

  1. Fork the repository and create your branch from main
  2. Install all dependencies (dart packages get or pub get)
  3. Squash your commits and ensure you have a meaningful commit message.
  4. If you’ve fixed a bug or added code that should be tested, add tests!
  5. Ensure the test suite passes and has 100% coverage.
  6. If you've changed the public API, make sure to update/add documentation.
  7. Format your code (dart format .)
  8. Analyze your code (dart analyze --fatal-infos --fatal-warnings lib)
  9. Create the Pull Request.
  10. Verify that all status checks are passing.

License

By contributing to Tenor Dart, you agree that your contributions will be licensed under its BSD-3-Clause license.