Thank you for your interest in contributing to PyGPTPrompt! Your help is crucial in improving this project. This document provides guidelines and instructions for contributing.
Please read and follow our Code of Conduct to ensure a positive and inclusive environment for everyone.
There are several ways you can contribute to PyGPTPrompt:
- Report issues or suggest new features by submitting an issue.
- Improve documentation or fix typos.
- Submit bug fixes or new features by creating a pull request.
When submitting an issue, please follow these guidelines:
- Check if the issue already exists.
- Use a clear and descriptive title.
- Provide a detailed description of the issue or feature request.
- Include any relevant code snippets, error messages, or screenshots.
To submit a pull request, follow these steps:
- Fork the repository and create a new branch for your changes.
- Clone the forked repository to your local machine and switch to the new branch.
- Make your changes, commit them, and push them to your fork.
- Open a pull request from your fork to the original repository.
- Provide a detailed description of the changes and reference any related issues.
Please ensure your code adheres to the project's coding standards and that all tests pass before submitting your pull request.
Please follow these coding standards when contributing to PyGPTPrompt:
- Use descriptive variable and function names.
- Comment your code where necessary.
- Follow the existing code style and indentation.
- Write tests for your changes when applicable.
Your help in making PyGPTPrompt better is greatly appreciated. Your contributions are valuable to the project and the community. Thank you for your time and effort!