Thank you for considering contributing to TeachGPT! We welcome contributions from the community to help improve and enhance our project. Please take a moment to review this document to understand how you can contribute effectively.
If you encounter a bug, have a feature request, or want to suggest an improvement, please open an issue on our GitHub issue tracker. When reporting issues, be sure to provide as much detail as possible, including steps to reproduce the problem, your operating system, and the TeachGPT version you are using.
We encourage you to contribute code to TeachGPT through pull requests. To do so, please follow these steps:
- Fork the TeachGPT repository to your own GitHub account.
- Clone the forked repository to your local machine.
- Create a new branch for your changes:
git checkout -b feature-name. - Implement your changes and commit them with meaningful commit messages.
- Push your changes to your forked repository.
- Create a pull request (PR) to the main TeachGPT repository, describing your changes and the problem they solve.
Our team will review your PR, provide feedback, and merge it if it meets our guidelines.
Please follow the existing code style and formatting guidelines in the project to maintain consistency. If you are introducing new code, ensure that it adheres to the established style.
If your changes include new functionality or modifications, please write appropriate unit tests to ensure that the code works as expected. Run the existing tests to ensure that your changes do not introduce regressions.
We expect all contributors and community members to treat each other with respect and create a welcoming and inclusive environment.
If you have questions or need assistance while contributing, feel free to reach out to us via our GitHub Discussions
By contributing to TeachGPT, you agree to abide by this contributing guide and the project's code of conduct.