Skip to content

Commit 0e8cd9a

Browse files
committed
add github stuff
1 parent ac51dd2 commit 0e8cd9a

File tree

8 files changed

+164
-0
lines changed

8 files changed

+164
-0
lines changed

.github/CODE_OF_CONDUCT.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Code of Conduct
2+
3+
Above all, SQLAlchemy places great emphasis on polite, thoughtful, and
4+
constructive communication between users and developers.
5+
Please see our current Code of Conduct at
6+
[Code of Conduct](http://www.sqlalchemy.org/codeofconduct.html).

.github/CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Contributing to SQLAlchemy
2+
3+
Please see out current Developer Guide at [Develop](https://www.sqlalchemy.org/develop.html)

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: requires triage
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
<!-- A clear and concise description of what the bug is. -->
12+
13+
**Expected behavior**
14+
<!-- A clear and concise description of what you expected to happen. -->
15+
16+
**To Reproduce**
17+
Please try to provide a [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) example.
18+
See also [Reporting Bugs](https://www.sqlalchemy.org/participate.html#bugs) on the website, and some [example issues](https://github.com/sqlalchemy/sqlalchemy/issues?q=label%3A%22great+mcve%22).
19+
20+
**Please do not use Flask-SQLAlchemy or any other third-party extensions or dependencies in test cases**. The test case must illustrate the problem **without** using any third party SQLAlchemy extensions. Otherwise, please report the bug to those projects first.
21+
22+
```py
23+
# Insert code here
24+
```
25+
26+
**Error**
27+
28+
```
29+
# Copy error here. Please include the full stack trace.
30+
```
31+
32+
**Versions.**
33+
- OS:
34+
- Python:
35+
- SQLAlchemy:
36+
- Database:
37+
- DBAPI:
38+
39+
**Additional context**
40+
<!-- Add any other context about the problem here. -->
41+
42+
**Have a nice day!**
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: requires triage
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.
21+
22+
**Have a nice day!**

.github/ISSUE_TEMPLATE/question.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Question
3+
about: Question regarding SQLAlchemy stub features
4+
title: ''
5+
labels: requires triage
6+
assignees: ''
7+
8+
---
9+
10+
**Describe your question**
11+
12+
**Example - please use the [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) guidelines if possible**
13+
14+
**Complete stack trace, if applicable**
15+
16+
**Versions**
17+
- OS:
18+
- Python:
19+
- SQLAlchemy:
20+
- Database:
21+
- DBAPI:
22+
23+
**Additional context**
24+
Add any other context or screenshots about the feature request here.
25+
26+
**Useful links**
27+
- [Get Support](https://www.sqlalchemy.org/support.html) on the website
28+
- The [documentation](https://docs.sqlalchemy.org/en/latest/) website
29+
- The [UsageRecipes](https://github.com/sqlalchemy/sqlalchemy/wiki/UsageRecipes) wiki
30+
- [Stack Overflow](https://stackoverflow.com/questions/tagged/sqlalchemy) tag
31+
- SQLAlchemy [Google group](http://groups.google.com/group/sqlalchemy)
32+
- [Gitter](https://gitter.im/sqlalchemy/community) chat
33+
34+
**Have a nice day!**

.github/SECURITY.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Security Policy
2+
3+
## Supported Versions
4+
5+
For the current supported version of SQLAlchemy, see "Current Release Series" at
6+
https://www.sqlalchemy.org/download.html#current.
7+
8+
## Reporting a Vulnerability
9+
10+
SQLAlchemy participates in the Tidelift security infrastructure for reporting
11+
potential vulnerabilities reponsibly. Please follow the guidelines at:
12+
13+
https://tidelift.com/docs/security
14+
15+
in order to report a security issue. Security-related issues in SQLAlchemy
16+
are extremely rare. Nevertheless, we would ask that you please do not file
17+
CVEs without emailing us first, so that proper disclosure steps may be taken.
18+
19+

.github/pull_request_template.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<!-- Provide a general summary of your proposed changes in the Title field above -->
2+
3+
### Description
4+
<!-- Describe your changes in detail -->
5+
6+
### Checklist
7+
<!-- go over following points. check them with an `x` if they do apply, (they turn into clickable checkboxes once the PR is submitted, so no need to do everything at once)
8+
9+
-->
10+
11+
This pull request is:
12+
13+
- [ ] A documentation / typographical error fix
14+
- Good to go, no issue or tests are needed
15+
- [ ] A short code fix
16+
- please include the issue number, and create an issue if none exists, which
17+
must include a complete example of the issue. one line code fixes without an
18+
issue and demonstration will not be accepted.
19+
- Please include: `Fixes: #<issue number>` in the commit message
20+
- please include tests. one line code fixes without tests will not be accepted.
21+
- [ ] A new feature implementation
22+
- please include the issue number, and create an issue if none exists, which must
23+
include a complete example of how the feature would look.
24+
- Please include: `Fixes: #<issue number>` in the commit message
25+
- please include tests.
26+
27+
**Have a nice day!**

README.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,17 @@ as the Dropbox stubs for the initial release.
1818
See the Mypy plugin documentation at https://docs.sqlalchemy.org/en/14/orm/extensions/mypy.html
1919
for an overview of how to use PEP-484 annotations with ORM mapped classes.
2020

21+
Code of Conduct
22+
---------------
2123

24+
Above all, SQLAlchemy places great emphasis on polite, thoughtful, and
25+
constructive communication between users and developers.
26+
Please see our current Code of Conduct at
27+
`Code of Conduct <http://www.sqlalchemy.org/codeofconduct.html>`_.
2228

29+
License
30+
-------
31+
32+
SQLAlchemy is distributed under the `MIT license
33+
<http://www.opensource.org/licenses/mit-license.php>`_.
2334

0 commit comments

Comments
 (0)