Skip to content

Latest commit

 

History

History
55 lines (35 loc) · 2.34 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.34 KB

Contributing to Test Driven Dart

First and foremost, thank you! We appreciate that you want to contribute to Test Driven Dart. Your time and effort will help many Dart developers master the art of testing.

Code of Conduct

By participating in this project, you are expected to uphold our Code of Conduct.

How to Contribute

Reporting Bugs

  1. Ensure the bug was not already reported by searching on GitHub under Issues.
  2. If you're unable to find an open issue addressing the problem, open a new one. Be sure to include:
    • A title and clear description
    • As much relevant information as possible
    • A code sample or an executable test case demonstrating the expected behavior that is not occurring.

Suggesting Enhancements

  1. Check the Issues to see if there's already an enhancement suggestion that matches yours.
  2. If not, create a new Issue with your suggestion. Be as clear and detailed as possible.

Pull Requests

  1. Fork the repository and create your branch from master.
  2. Install the dependencies if you haven't already.
  3. Make your changes ensuring they follow the existing code style and structure.
  4. Run the tests to ensure no existing functionality is broken.
  5. Add or update tests for your changes.
  6. Commit your changes following a clear commit message pattern.
  7. Push to your fork and submit a pull request to the master branch.

Styleguides

Git Commit Messages

  • Use the present tense ("Add feature" not "Added feature").
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
  • Limit the first line to 72 characters or less.
  • Reference issues and pull requests liberally after the first line.

Dart Styleguide

Follow the official Dart style guide.

Additional Notes

Issue and Pull Request Labels

Label your issues or pull requests appropriately to help maintainers and other contributors understand your contribution's purpose and priority.

Conclusion

Your contributions are a valuable part of making this repository a comprehensive guide on Dart testing. By contributing, you're helping countless Dart developers improve their testing skills.