Contributing to Lithops
Lithops is an open-source project, and we welcome contributions from the community. Whether you're fixing bugs, adding new features, improving documentation, or spreading the word, your help is appreciated.
How to Contribute
1. Fork the Repository
Start by forking the Lithops repository on GitHub.
git clone https://github.com/your-username/lithops.git 2. Create a Branch
Create a branch for your changes. Use a descriptive name that reflects the purpose of your changes.
git checkout -b feature/your-feature-name 3. Make Your Changes
Make your changes to the codebase. Be sure to follow the coding style and guidelines of the project.
If you're adding a new feature, consider adding tests and documentation for it.
4. Run Tests
Make sure all tests pass before submitting your changes.
python -m pytest 5. Submit a Pull Request
Push your changes to your fork and submit a pull request to the main repository.
git push origin feature/your-feature-name In your pull request description, explain the changes you've made and why they're needed.
Contribution Guidelines
- • Code Style - Follow the existing code style. We use PEP 8 for Python code.
- • Documentation - Update documentation for any changes you make.
- • Tests - Add tests for new features and make sure all tests pass.
- • Commit Messages - Write clear, concise commit messages that explain your changes.
- • Pull Requests - Keep pull requests focused on a single change or feature.
Get in Touch
If you have questions or need help, you can: