Thank you for your interest in contributing to the runpod-python project! This document is a set of guidelines for contributing to this project on GitHub. These are guidelines, not rules. This guide is meant to make it easy for you to get involved.
If you have found a bug or would like to suggest a new feature or enhancement, please start by checking if there is an existing issue for it. If there isn't one, you can create one, clearly describing the bug or feature, with as much detail as possible.
Here is a quick guide on how to contribute code to this project:
-
Fork the repository and create your branch from
main. -
Clone the forked repository to your machine.
git clone https://github.com/<your-username>/runpod-python.git
-
Navigate to your local repository.
cd runpod-python -
Create a branch for your edits.
git checkout -b name-of-your-branch
-
Make your changes in the new branch.
-
Run tests to ensure that your changes do not break any existing functionality. You can run tests using the following command:
pip install '.[test]' pytest -
Commit your changes, providing descriptive commit messages.
git commit -am "Your descriptive commit message" -
Push your changes to your GitHub account.
git push -u origin name-of-your-branch
-
Open a Pull Request against the main branch of this repository.
Please note that the project maintainers will review your changes. They might ask for changes before your Pull Request gets merged. Coding is a group activity, and collaboration is key!
This project adheres to the PEP 8 code style. We use Black to format our code. To ensure your code fits with the style, run Black on your code before committing.
Before submitting a pull request, please make sure your changes pass all tests. New features should include additional unit tests validating the changes.
If you have any questions or need help with contributing, feel free to reach out on the issue tracker or open a new issue. We're here to help!
Thank you for contributing!