Everyone participating in this project is governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
This section guides you through submitting a bug report for GQLAlchemy. Following these guidelines helps maintainers and the community understand your report, reproduce the behavior, and find related reports.
Before creating a bug report, please check out GitHub Issues, as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, so we can get all the needed information to resolve the issue.
Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
The base branch of the project is the main branch. Whenever the next milestone is reached, a new release of GQLAlchemy is created in the GitHub repository and on PyPI. Also, new branch release/<version> is created for every major or minor release.
The release/<version> branch is where new releases of GQLAlchemy are published to. You can track the progress of each release through GitHub Milestones. When the release is finished on the main branch, the new release/<version> branch will be published.
Please send a GitHub Pull Request with a clear list of what you've done. Make sure all of your commits are atomic (one feature per commit).
There are two main types of contributions:
- Critical bug fixes
- New features or low priority bug fixes
Both types of fixes should be applied to the main branch.
In order for a pull request to be merged, a review by two code owners is required and the tests need to pass remotely.
If you need help with contributing to the GQLAlchemy project, join our Discord server.