We welcome contributions to openai-go-sdk and appreciate your efforts to improve the project. Whether you're fixing bugs, adding new features, or improving documentation, your contribution is essential for the growth of this project.
Before contributing, please ensure you have read and understood our contribution guidelines. Here's how you can contribute:
-
Report issues: If you find a bug or have a suggestion for improvement, please first check if it has already been reported. If not, feel free to open a new issue.
-
Respond to issues: Feel free to respond to open issues, providing additional context or suggestions.
-
Fork the repository: Start by forking the repository and then clone your fork.
-
Create a new branch: Create a branch in your fork for your contribution.
-
Make your changes: Work on your changes ensuring that they meet our coding standards and guidelines.
-
Write tests: Add or update tests as necessary for your changes.
-
Update documentation: Update the documentation to reflect your changes, if applicable.
-
Submit a pull request: Once your changes are ready, submit a pull request to the main repository.
-
Code style: Follow the coding style of the project. If you're unsure about the style, please refer to existing code or ask in a comment on your issue or pull request.
-
Commit messages: Write meaningful commit messages that clearly describe the changes you've made.
-
Testing: Ensure your code passes all tests, and if you're adding new functionality, include new tests.
-
Respectful communication: Always communicate respectfully with other contributors. Disagreements are normal, but approach them with an open mind and a collaborative spirit.
-
Inclusive environment: We strive to create an inclusive and diverse environment. We do not tolerate discrimination or harassment in any form.
If you have any questions, feel free to open an issue with your question, and we will do our best to provide assistance.
Thank you for contributing to openai-go-sdk!