Contributing
We welcome contributions to the Meteostat Python library! Whether you want to report bugs, suggest new features, or improve the documentation, your input is valuable to us. Here are some ways you can contribute:
- Report Issues: If you encounter any bugs or issues while using the library, please report them on our GitHub Issues page
- Feature Requests: Have an idea for a new feature? Let us know by submitting a feature request on our GitHub Discussions page
- Pull Requests: If you'd like to contribute code, feel free to fork the repository, make your changes, and submit a pull request. Please ensure that your code adheres to our coding standards and includes appropriate tests.
👀 Learn More
📄️ Linting & Formatting
To maintain code quality and consistency across the Meteostat Python library, we use Ruff, a Python linter and code formatter, written in Rust. Ruff helps us identify and fix common issues in our codebase, ensuring that our code adheres to best practices and style guidelines. Contributors are encouraged to run Ruff locally before submitting pull requests to catch any potential issues early. If available for your IDE, consider installing the Ruff extension (VS Code) to get real-time feedback while coding.
📄️ Testing
The Meteostat Python library uses Pytest as its testing framework. Pytest is a powerful and flexible testing tool that makes it easy to write simple and scalable test cases for your code.