Community Guide
A guide to getting involved with SQLAlchemy and its associated projects.
While these sections may be written to address developers of the core SQLAlchemy project, the various guidelines, especially the Code of Conduct, apply to all projects hosted under the SQLAlchemy organization's repository.
Get Support
Before requesting support, please try to make use of the available online resources, where the answers to a large number of questions can already be found. The most important is the documentation. A great deal of questions asked in SQLAlchemy forums are answered through simple searches using the search box in the upper right of the index page or in the left hand column of any documentation page. The documentation is worked on and improved constantly, sometimes dramatically so. Issues with the documentation may be reported as bugs (see reporting bugs). Another approach is to search through the GitHub Discussions forum which is fast becoming a primary informational resource.
GitHub Discussions
SQLAlchemy and its related projects now offer support via the GitHub Discussions link on the GitHub page for each project. This forum-style interface allows for discussions more or like that of a mailing list, but with better support for illustrating code samples and linking to issues. When posting on the discussions forum, we ask that posters try, to the best of their ability, to compose messages are both complete in their description as well as succinct with regards to the topic at hand:
- Complete - important details like the version of SQLAlchemy in use, the type of database being worked with (MySQL 8, PostgreSQL 12, etc.), as well as full stack traces for error messages are provided, as well as clear sections of code illustrating the exact usage that leads to the symptom.
- Succinct - code and output is trimmed and formatted to illustrate only the problem at hand - details that aren't directly relevant to the issue at hand should be trimmed out as much as possible, including unrelated tables and models, dependencies on internal or third party libraries, unrelated object methods and relationships, large numbers of column definitions that can be omitted, complicated internal variable names that are difficult for outsiders to read.
These are only guidelines to follow, as we can and regularly do accommodate users of all skill levels. As long as some effort is apparent on your part to research and thoughtfully describe the issue, you've earned support from us !
Real-time Channels: Gitter
The sqlalchemy/community Gitter room is available for real-time support. There are usually a handful of SQLAlchemy users and developers present and willing to assist.
