First off, thank you for considering contributing to Cool School. It's people like you that make Cool School such a great tool. Cool School is a collaborative project, and we welcome contributions of all kinds: from writing code or documentation to reporting bugs or suggesting new features.
Before you begin, please ensure you have a GitHub account and are familiar with GitHub workflows. Here are some resources to help you get started with GitHub:
You can contribute to Cool School in several ways. Here are some ideas:
- Reporting Bugs: If you find a bug, please open an issue to report it. Be sure to include detailed information about the bug and how to reproduce it.
- Suggesting Enhancements: Have an idea for a new feature or think something could be improved? Open an issue to suggest your enhancement.
- Writing Documentation: Good documentation is crucial to any project. If you enjoy writing and wish to improve our docs, you're at the right place!
- Submitting Code Changes: If you'd like to contribute code, please make a pull request. Whether it's fixing a bug, adding a feature, or improving documentation, we welcome your contributions.
- Fork the repository and create your branch from
main. - If you've added code, write tests that cover your changes.
- Ensure your code follows the project's coding conventions.
- Ensure your code passes all tests.
- Ensure your changes are well-documented.
- Submit a pull request to the original repository.
Cool School is committed to fostering a welcoming community. By participating in this project, you agree to abide by the Code of Conduct.
If you have any questions or need further guidance, feel free to open an issue or reach out to the maintainers. We're here to help and appreciate your contributions.
Thank you for contributing to Cool School!