Guidelines for Contributing
TorchGP values the contributions of interested individuals or groups. The following guidelines provide information on how you can contribute to the library:
There are four primary ways to contribute to TorchGP, listed below in descending order of difficulty:
- 🔧 Adding or improved functionality to the existing codebase.
- 🐛 Fixing issues or bugs with the existing codebase.
- 📖 Adding or improving the documentation and examples.
- 🙏 Submitting issues related to bugs or desired enhancements.
We look forward to reviewing your contributions and thank you for your interest in improving TorchGP!
Pull Request Guidelines
The first three types of contributions (adding or fixing code and documentation) can be submitted by creating a pull request. Here's an overview of the process for creating a pull request:
-
Fork the repository and create a branch
Create a branch with a descriptive name for your changes. This will help us understand the purpose of your pull request.
-
Make the changes
Make your changes to the codebase. Please ensure that your code is well-written and follows our code style guidelines.
-
Submit the Pull Request
Submit your pull request with a clear and concise title and description. Please include any relevant information or context that may be helpful in reviewing your changes.
-
Respond to feedback
We may ask for changes to be made to your pull request. Please respond to feedback promptly and make any necessary changes.
-
Merge the pull request
Once your pull request has been reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!