Thank you for your interest in contributing to our project!
Timescale appreciates any help the community can provide to make the PostgreSQL ecosystem better.
For general guidelines on how to contribute to Timescale, please see the Timescale Contribution Guidelines.
- Fork the repository and create your branch from
main. - If you've added more examples, please document it in the README.md.
- Make sure your code lints.
- Issue that pull request!
- Ensure the bug was not already reported by searching on GitHub under Issues.
- If you're unable to find an open issue addressing the problem, open a new one. Be sure to include a title and clear description, as much relevant information as possible, and a code sample or an executable test case demonstrating the expected behavior that is not occurring.
- Open a new issue with a clear title and detailed description of the proposed enhancement.
- Explain why this enhancement would be useful to most users.
- Include any relevant code samples or mockups if applicable.
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations and container parameters.
- Increase the version numbers in any examples files and the README.md to the new version that this Pull Request would represent.
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
- Use clear, descriptive variable and function names.
- Comment your code where necessary, especially for complex logic.
- Follow PEP 8 style guide for Python code.
By contributing, you agree that your contributions will be licensed under the same license as the original project.
Thank you for contributing to our project!