Contribution Guide

Ini Arthurto add content from contributing guide and laravel documentation.

Contributing to DartStream

Thank you for considering contributing to DartStream, a Dart language backend framework designed for building efficient and scalable server-side applications. Your contributions make this project better and are greatly appreciated.

Quicklinks

• Code of Conduct

• What We Are Looking For

• How to Contribute

• Getting Started

• Pull Request Guidelines

• Reporting Bugs

• Feature Requests

• Improving Documentation

• Available Versions

• Community

Code of Conduct

By participating and contributing to DartStream, you are expected to uphold our Code of Conduct.

What We Are Looking For

We welcome contributions in various forms, such as:

• Bug reports and fixes

• Feature requests and implementations

• Documentation improvements

• Feedback on the framework's performance and design

How to Contribute

If you're interested in contributing, please:

1. Fork the repository and create your branch from main.

2. Adhere to the coding standards and guidelines for Dart.

3. Include unit tests for any new or changed functionality.

4. Update documentation as necessary.

5. Submit a pull request with detailed information about your changes.

For more significant changes, please open an issue to discuss your ideas before moving forward.

Getting Started

Set up your environment by:

1. Forking and cloning the project repository.

2. Installing Dart and any required dependencies.

3. Following the setup instructions to prepare your development environment.

Pull Request Guidelines

Ensure your pull request adheres to the following:

1. Aligns with the project's code style and best practices.

2. Passes all existing tests and any new tests related to your changes.

3. Updates or adds documentation as needed.

4. Describes the changes made and the reasoning behind them.

Reporting Bugs

When reporting bugs, include:

• Clear and descriptive title.

• Step-by-step reproduction instructions.

• Expected and actual behavior.

• Environment details (OS, Dart version, etc.).

Feature Requests

We encourage feature requests that enhance the framework. Please:

• Provide a clear and detailed explanation of the feature.

• Explain how it aligns with the framework's goals.

• Discuss potential implementation and impact.

Improving Documentation

Your contributions to improve or clarify documentation are always welcome. Whether it's typo corrections, additional examples, or clearer explanations, your help is invaluable.

Available Versions

DartStream is available to the Dart community in three versions:

1. Free - Open Source Version: Available for anyone to use, modify, and distribute according to the needs of their project.

2. Hosted Framework: Similar to Laravel Vapor, this version provides a managed, hosted solution for those looking to deploy DartStream applications with ease.

3. Aortem - SAAS Version: The most comprehensive version, offering full SaaS capabilities for enterprise needs, including additional features and support and a full host of Native Dart SDK's for your most popular integrations.

Community

Join the discussion on issues, contribute to pull requests, or reach out through [specified communication channels] for more informal discussions. Your input is crucial to the project's success.