From 0e8cd9accf74fc6129a467de5b01d3755c5707fb Mon Sep 17 00:00:00 2001 From: Federico Caselli Date: Thu, 18 Mar 2021 23:00:15 +0100 Subject: [PATCH] add github stuff --- .github/CODE_OF_CONDUCT.md | 6 ++++ .github/CONTRIBUTING.md | 3 ++ .github/ISSUE_TEMPLATE/bug_report.md | 42 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 22 ++++++++++++ .github/ISSUE_TEMPLATE/question.md | 34 ++++++++++++++++++ .github/SECURITY.md | 19 ++++++++++ .github/pull_request_template.md | 27 +++++++++++++++ README.rst | 11 ++++++ 8 files changed, 164 insertions(+) create mode 100644 .github/CODE_OF_CONDUCT.md create mode 100644 .github/CONTRIBUTING.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/question.md create mode 100644 .github/SECURITY.md create mode 100644 .github/pull_request_template.md diff --git a/.github/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..3b8e9bf --- /dev/null +++ b/.github/CODE_OF_CONDUCT.md @@ -0,0 +1,6 @@ +# Code of Conduct + +Above all, SQLAlchemy places great emphasis on polite, thoughtful, and +constructive communication between users and developers. +Please see our current Code of Conduct at +[Code of Conduct](http://www.sqlalchemy.org/codeofconduct.html). \ No newline at end of file diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md new file mode 100644 index 0000000..d5f4005 --- /dev/null +++ b/.github/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# Contributing to SQLAlchemy + +Please see out current Developer Guide at [Develop](https://www.sqlalchemy.org/develop.html) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a0a229c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,42 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: requires triage +assignees: '' + +--- + +**Describe the bug** + + +**Expected behavior** + + +**To Reproduce** +Please try to provide a [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) example. +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). + +**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. + +```py +# Insert code here +``` + +**Error** + +``` +# Copy error here. Please include the full stack trace. +``` + +**Versions.** + - OS: + - Python: + - SQLAlchemy: + - Database: + - DBAPI: + +**Additional context** + + +**Have a nice day!** diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..818bd38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,22 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: requires triage +assignees: '' + +--- + +**Is your feature request related to a problem? Please describe.** +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +**Describe the solution you'd like** +A clear and concise description of what you want to happen. + +**Describe alternatives you've considered** +A clear and concise description of any alternative solutions or features you've considered. + +**Additional context** +Add any other context or screenshots about the feature request here. + +**Have a nice day!** diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..df2a304 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,34 @@ +--- +name: Question +about: Question regarding SQLAlchemy stub features +title: '' +labels: requires triage +assignees: '' + +--- + +**Describe your question** + +**Example - please use the [Minimal, Complete, and Verifiable](http://stackoverflow.com/help/mcve) guidelines if possible** + +**Complete stack trace, if applicable** + +**Versions** + - OS: + - Python: + - SQLAlchemy: + - Database: + - DBAPI: + +**Additional context** +Add any other context or screenshots about the feature request here. + +**Useful links** +- [Get Support](https://www.sqlalchemy.org/support.html) on the website +- The [documentation](https://docs.sqlalchemy.org/en/latest/) website +- The [UsageRecipes](https://github.com/sqlalchemy/sqlalchemy/wiki/UsageRecipes) wiki +- [Stack Overflow](https://stackoverflow.com/questions/tagged/sqlalchemy) tag +- SQLAlchemy [Google group](http://groups.google.com/group/sqlalchemy) +- [Gitter](https://gitter.im/sqlalchemy/community) chat + +**Have a nice day!** diff --git a/.github/SECURITY.md b/.github/SECURITY.md new file mode 100644 index 0000000..6ca98a3 --- /dev/null +++ b/.github/SECURITY.md @@ -0,0 +1,19 @@ +# Security Policy + +## Supported Versions + +For the current supported version of SQLAlchemy, see "Current Release Series" at +https://www.sqlalchemy.org/download.html#current. + +## Reporting a Vulnerability + +SQLAlchemy participates in the Tidelift security infrastructure for reporting +potential vulnerabilities reponsibly. Please follow the guidelines at: + +https://tidelift.com/docs/security + +in order to report a security issue. Security-related issues in SQLAlchemy +are extremely rare. Nevertheless, we would ask that you please do not file +CVEs without emailing us first, so that proper disclosure steps may be taken. + + diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..01bdac9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ + + +### Description + + +### Checklist + + +This pull request is: + +- [ ] A documentation / typographical error fix + - Good to go, no issue or tests are needed +- [ ] A short code fix + - please include the issue number, and create an issue if none exists, which + must include a complete example of the issue. one line code fixes without an + issue and demonstration will not be accepted. + - Please include: `Fixes: #` in the commit message + - please include tests. one line code fixes without tests will not be accepted. +- [ ] A new feature implementation + - please include the issue number, and create an issue if none exists, which must + include a complete example of how the feature would look. + - Please include: `Fixes: #` in the commit message + - please include tests. + +**Have a nice day!** diff --git a/README.rst b/README.rst index 364dbb8..840941e 100644 --- a/README.rst +++ b/README.rst @@ -18,6 +18,17 @@ as the Dropbox stubs for the initial release. See the Mypy plugin documentation at https://docs.sqlalchemy.org/en/14/orm/extensions/mypy.html for an overview of how to use PEP-484 annotations with ORM mapped classes. +Code of Conduct +--------------- +Above all, SQLAlchemy places great emphasis on polite, thoughtful, and +constructive communication between users and developers. +Please see our current Code of Conduct at +`Code of Conduct `_. +License +------- + +SQLAlchemy is distributed under the `MIT license +`_.