Title here
Summary here
Contributing Overview
We're excited that you're interested in contributing to Oakestra! This guide provides an overview of how to get started as a contributor. Whether you’re fixing bugs, improving documentation, or developing new features, your contribution is valued and important.Our Community Goals
Oakestra is a welcoming, collaborative, and inclusive community. We want Oakestra to be a place where contributors feel empowered to share ideas, ask questions, and grow. All contributors are expected to follow our Code of Conduct to keep our community positive and open.
The Open Source Guides website has a collection of resources for individuals, communities, and companies who want to learn how to run and contribute to an open source project.
Contributors and people new to open source alike will find the following guides especially useful.
Code of Conduct
Oakestra is committed to a respectful and inclusive environment. By contributing, you agree to abide by our Code of Conduct.
Contribution Guidelines
If you are eager to start contributing code right away, we have a list of good first issues that contain bugs which have a relatively limited scope. Alternatively, you can ceck for issues labeled as “help wanted” for feature extensions that have not been handled yet. As you gain more experience and demonstrate a commitment to evolving Oakestra, you may be granted issue management permissions in the repository.
How to contribute on GitHub?
Just comment on an unassigned issue, stating you want to work on it. Once you get an ACK from one of the maintainers, you’ll get assigned to a branch related to the issue. All your work must be merged to the assigned branch first via Pull Request.
There are other ways you can contribute without writing a single line of code. Here are a few things you can do to help out:
Reporting Bugs
Found a bug? Please report it by creating a GitHub issue. Clear and detailed bug reports are invaluable.Suggesting Features
Have a new feature idea? Feature requests are welcome! Please submit them as GitHub issues with details on why it would be useful and any implementation suggestions.Improving Documentation
Documentation improvements are always appreciated! If you find something unclear or missing, feel free to submit an issue.
Reviewing and Merging Pull Requests
Your PR will be reviewed by a maintainer. Please be patient, as we maintain high standards for code quality and project alignment. Changes may be requested.
Coding Guidelines
- Code Style: Follow the Oakestra Coding Style Guide.
- Commit Messages: Use Conventional Commits.
- Documentation: Update relevant documentation, especially if introducing new features or changing functionality.
Join the Community
We encourage discussions on our Discord page, where you can share ideas and interact with other members of the community (including contributors).