👍🎉 First off, thanks for taking the time to contribute! 🎉👍
The following is a set of guidelines for contributing to PyDough, which is hosted in the Bodo Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
This project and everyone participating in it is governed by the PyDough Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
If you encounter a bug, please:
- Search the issue tracker to see if it has already been reported.
- If not, open a new issue with details about:
- Steps to reproduce the issue
- Expected behavior
- Actual behavior
- Any relevant logs or screenshots
We welcome contributions from everyone! To get started:
- Fork the repository and clone it to your local machine.
- Follow the instructions in the repository's README to set up the project.
- Check the good first issue label for beginner-friendly tasks.
- Create a branch, make your changes, and open a pull request!
To submit a pull request:
- Ensure your changes align with the project's style and conventions.
- Write clear commit messages and provide context for your changes in the pull request description.
- Reference any related issues (e.g., "Closes #123").
- Be responsive to feedback during the review process.
We believe in fostering a collaborative and welcoming community! If you have questions or need help:
- Join our Slack workspace: Slack Invite Link
- Send an email directly to [email protected] Feel free to ask questions, share ideas, or discuss potential contributions. We're here to support you!
Thanks again for your interest in contributing to PyDough! 🚀