Contributing

Welcome to Slyme! 🎉 We are thrilled that you are considering contributing to this project. Whether it's fixing bugs, improving documentation, or proposing new feature ideas, every participation makes Slyme better.

Submitting Pull Requests

We greatly look forward to receiving your Pull Requests (PRs). When preparing to submit code, please keep the following simple development guidelines in mind:

• Code Formatting: We uniformly use ruff as our code formatting and linting tool. Before submitting code, please ensure your code has been checked with ruff for formatting.
• Pipeline Under Development: We are actively configuring and improving the project's CI/CD pipeline. Therefore, the current contribution process may still be iteratively optimizing. If you encounter any workflow questions when submitting code, please feel free to leave a comment, and we will be happy to assist!

Regarding Feature Extensions and API Design

As the core foundation of the entire ecosystem, Slyme's stability directly affects all developers who depend on it.

Because of this, we adopt a rigorous but absolutely open attitude toward introducing new features or adjusting core APIs. But this is by no means to keep everyone's good ideas out! On the contrary, we are very eager to hear your innovative ideas.

We hope that before everyone invests significant effort in writing code, they can fully communicate with you and the entire community. Through collective brainstorming in the early stages, we can jointly refine a better development experience while ensuring backward compatibility and system stability.

A Small Suggestion

If you have a brilliant idea about new features or API design, it is highly recommended to open an Issue to discuss your thoughts with us before writing any code. We look forward to exploring the best implementation plan with you!

Thank you again for your attention and support of Slyme. We look forward to your contributions!