Contributing

Getting Started

• Review Existing Contributions and Issues: Before submitting, please check if a similar issue or feature request already exists by searching our issue tracker.

Submitting Issues

Use one of the [templates] to submit an issue to the Project Board. Ensure the title is a clear summary of the requirement and provides enough context.

Issue Types:

• Bug Report: Provide detailed information about the issue, including steps to reproduce it, expected behavior, and actual behavior, screenshots, or any other relevant information.
• Documentation Improvement: Clearly describe the improvement requested for existing content and/or raise missing areas of documentation and provide details for what should be included.
• Feature Request: Clearly describe your feature, its benefits, and most importantly, the expected outcome. This helps us analyze the proposed solution and develop alternatives.

Code Contribution Process

• Pull Requests: Code contributions are submitted via Pull Requests.
• Fork the Repository: Create your own fork of the Starstream repository.
• Create a Branch: Make your changes in a separate branch.
• Follow Coding Standards: Adhere to the coding style guides specified in our documentation.
• Write Tests: Include unit tests and integration tests to cover your changes.
• Commit Messages: Write clear and concise commit messages.
• Submit Pull Request: Submit your pull request to the appropriate branch in the main repository.
• Code Review: All pull requests undergo code review by project maintainers. Be prepared to address feedback from reviewers.

Requirements for Acceptable Contributions:

• Coding Standards: Code must adhere to the coding style guides defined in our documentation
• Testing: New functionality must include corresponding unit tests and integration tests.
• Documentation: Code changes should be accompanied by proposed relevant documentation updates.
• License: By contributing to this project, you agree that your contributions will be licensed under the same license as the project.

Support and Communication:

Connect with us on Discord