Skip to content

Latest commit

 

History

History
46 lines (30 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 2.91 KB
Raw

Contributing to dart_seq

Thank you for your interest in contributing to dart_seq! We appreciate your support and value your contributions.

Before getting started, please take a moment to review the guidelines below to ensure a smooth and efficient contribution process.

Ways to Contribute

There are several ways you can contribute to dart_seq:

  1. Bug Reports: If you encounter any issues or bugs while using dart_seq, please report them on the GitHub issues page. Provide as much detail as possible, including steps to reproduce the issue and any relevant error messages or logs.
  2. Feature Requests: Have a great idea for a new feature or improvement? We'd love to hear it! Submit your feature request on the GitHub issues page, explaining the feature you'd like to see and providing any relevant use cases or examples.
  3. Code Contributions: If you're interested in contributing code to dart_seq, follow these steps:
  • Fork the dart_seq repository.
  • Create a new branch for your changes: git checkout -b feature/your-feature-name.
  • Make your code changes, adhering to the project's coding style and guidelines.
  • Write appropriate tests for your changes, ensuring that they pass successfully.
  • Commit your changes with a descriptive commit message: git commit -m "Add new feature: your feature name".
  • Push your branch to your forked repository: git push origin feature/your-feature-name.
  • Open a pull request on the GitHub repository, explaining your changes and providing any necessary context.

Code Guidelines

To maintain a consistent codebase and ensure readability, please adhere to the following guidelines when contributing to dart_seq:

  • Follow the Dart Style Guide for code formatting and structure (or use dart format lib before committing).
  • Write clear, concise, and self-explanatory code with appropriate comments where necessary.
  • Ensure that your code passes all existing tests, and write additional tests for any new features or changes.
  • Document any public APIs using DartDoc comments to provide clear and comprehensive documentation.

Communication

If you need any help or have questions regarding your contributions, feel free to reach out:

  • Contact me directly: ricardoboss.de/contact
  • Open a new GitHub issue for any project-related discussions or questions.

Code of Conduct

Please note that all contributors are expected to adhere to the Code of Conduct. By participating in this project, you are agreeing to abide by its terms.

We appreciate your contributions and look forward to building an inclusive and collaborative community around dart_seq!

Happy contributing!