Skip to content

Latest commit

 

History

History
58 lines (33 loc) · 2.36 KB

CONTRIBUTING.md

File metadata and controls

58 lines (33 loc) · 2.36 KB

Contributing to SakuraAI Bloom

Thank you for considering contributing to SakuraAI Bloom! By participating in this project, you agree to abide by the code of conduct outlined in the CODE_OF_CONDUCT.md.

Getting Started

Before you start contributing, make sure you have read the project's README.md for an overview of the project, its structure, and licensing information.

How Can I Contribute?

Reporting Bugs

If you find a bug, please open an issue on the GitHub Issues page. When reporting a bug, please include relevant details such as:

  • A clear and descriptive title.
  • Steps to reproduce the issue.
  • Expected behavior.
  • Actual behavior.
  • Your operating system and version.

Suggesting Enhancements

If you have an idea for an enhancement, feel free to open an issue on the GitHub Issues page. Provide a clear and detailed explanation of your proposed enhancement.

Pull Requests

We welcome contributions through pull requests (PRs). Before submitting a PR:

  1. Fork the repository and create your branch from main.
  2. If you've added code that should be tested, add relevant test cases.
  3. Ensure your code adheres to the project's coding standards.
  4. Make sure your commits are clear and have a meaningful message.

Commit Message Conventions

We use conventional commits for better versioning. Please follow the Conventional Commits Specification when writing your commit messages.

Coding Standards

Follow the coding standards specified in the project. If you are unsure, check the existing code for patterns.

Code Reviews

All submissions, including those by project members, require review. During the review process, maintainers may suggest changes or improvements or ask for clarification.

Code of Conduct

This project and everyone participating in it are governed by the SakuraAI Bloom Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]].

License

By contributing, you agree that your contributions will be licensed under the GPL-3.0 License. See the LICENSE file for details.


Thank you for your contributions!

Happy coding!