db-drift 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- db_drift-1.0.0/.github/FUNDING.yml +13 -0
- db_drift-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md +36 -0
- db_drift-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- db_drift-1.0.0/.github/ISSUE_TEMPLATE/question.md +21 -0
- db_drift-1.0.0/.github/PULL_REQUEST_TEMPLATE.md +29 -0
- db_drift-1.0.0/.github/SECURITY.md +49 -0
- db_drift-1.0.0/.github/dependabot.yml +39 -0
- db_drift-1.0.0/.github/workflows/ci.yml +35 -0
- db_drift-1.0.0/.github/workflows/release.yml +60 -0
- db_drift-1.0.0/.gitignore +207 -0
- db_drift-1.0.0/.python-version +1 -0
- db_drift-1.0.0/CHANGELOG.md +8 -0
- db_drift-1.0.0/CODE_OF_CONDUCT.md +122 -0
- db_drift-1.0.0/CONTRIBUTING.md +126 -0
- db_drift-1.0.0/LICENSE +21 -0
- db_drift-1.0.0/PKG-INFO +107 -0
- db_drift-1.0.0/README.md +78 -0
- db_drift-1.0.0/examples/.gitkeep +0 -0
- db_drift-1.0.0/pyproject.toml +114 -0
- db_drift-1.0.0/ruff.toml +101 -0
- db_drift-1.0.0/src/db_drift/__init__.py +2 -0
- db_drift-1.0.0/tests/.gitkeep +0 -0
- db_drift-1.0.0/uv.lock +1169 -0
@@ -0,0 +1,13 @@
|
|
1
|
+
# These are supported funding model platforms
|
2
|
+
|
3
|
+
github: # Replace with a single GitHub username or organization
|
4
|
+
patreon: # Replace with a single Patreon username
|
5
|
+
open_collective: # Replace with a single Open Collective username
|
6
|
+
ko_fi: irakliskonsoulas
|
7
|
+
tidelift: # Replace with a single Tidelift package-name e.g., npm/babel
|
8
|
+
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
|
9
|
+
liberapay: # Replace with a single Liberapay username
|
10
|
+
issuehunt: # Replace with a single IssueHunt username
|
11
|
+
otechie: # Replace with a single Otechie username
|
12
|
+
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
|
13
|
+
custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']
|
@@ -0,0 +1,36 @@
|
|
1
|
+
---
|
2
|
+
name: Bug report
|
3
|
+
about: Create a report to help us improve
|
4
|
+
title: '[BUG] '
|
5
|
+
labels: bug
|
6
|
+
assignees: ''
|
7
|
+
---
|
8
|
+
|
9
|
+
**Describe the bug**
|
10
|
+
A clear and concise description of what the bug is.
|
11
|
+
|
12
|
+
**To Reproduce**
|
13
|
+
Steps to reproduce the behavior:
|
14
|
+
1. Run command '...'
|
15
|
+
2. See error
|
16
|
+
|
17
|
+
**Expected behavior**
|
18
|
+
A clear and concise description of what you expected to happen.
|
19
|
+
|
20
|
+
**Maven dependency tree sample**
|
21
|
+
Please provide a sample of your Maven dependency tree output:
|
22
|
+
```
|
23
|
+
[paste your maven dependency tree here]
|
24
|
+
```
|
25
|
+
|
26
|
+
**Screenshots**
|
27
|
+
If applicable, add screenshots to help explain your problem.
|
28
|
+
|
29
|
+
**Environment:**
|
30
|
+
- OS: [e.g. Windows 10, macOS, Ubuntu 20.04]
|
31
|
+
- Python version: [e.g. 3.13]
|
32
|
+
- Package version: [e.g. 1.2.0]
|
33
|
+
- Maven version: [e.g. 3.8.1]
|
34
|
+
|
35
|
+
**Additional context**
|
36
|
+
Add any other context about the problem here.
|
@@ -0,0 +1,22 @@
|
|
1
|
+
---
|
2
|
+
name: Feature request
|
3
|
+
about: Suggest an idea for this project
|
4
|
+
title: '[FEATURE] '
|
5
|
+
labels: enhancement
|
6
|
+
assignees: ''
|
7
|
+
---
|
8
|
+
|
9
|
+
**Is your feature request related to a problem? Please describe.**
|
10
|
+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
|
11
|
+
|
12
|
+
**Describe the solution you'd like**
|
13
|
+
A clear and concise description of what you want to happen.
|
14
|
+
|
15
|
+
**Describe alternatives you've considered**
|
16
|
+
A clear and concise description of any alternative solutions or features you've considered.
|
17
|
+
|
18
|
+
**Use case**
|
19
|
+
Describe how this feature would be used and who would benefit from it.
|
20
|
+
|
21
|
+
**Additional context**
|
22
|
+
Add any other context or screenshots about the feature request here.
|
@@ -0,0 +1,21 @@
|
|
1
|
+
---
|
2
|
+
name: Question
|
3
|
+
about: Ask a question about usage or functionality
|
4
|
+
title: '[QUESTION] '
|
5
|
+
labels: question
|
6
|
+
assignees: ''
|
7
|
+
---
|
8
|
+
|
9
|
+
**Question**
|
10
|
+
What would you like to know?
|
11
|
+
|
12
|
+
**Context**
|
13
|
+
Provide any relevant context about your use case or what you're trying to achieve.
|
14
|
+
|
15
|
+
**What you've tried**
|
16
|
+
If applicable, describe what you've already tried.
|
17
|
+
|
18
|
+
**Environment (if relevant):**
|
19
|
+
- OS: [e.g. Windows 10, macOS, Ubuntu 20.04]
|
20
|
+
- Python version: [e.g. 3.13]
|
21
|
+
- Package version: [e.g. 1.2.0]
|
@@ -0,0 +1,29 @@
|
|
1
|
+
## Description
|
2
|
+
Brief description of the changes made in this PR.
|
3
|
+
|
4
|
+
## Type of Change
|
5
|
+
- [ ] Bug fix (non-breaking change which fixes an issue)
|
6
|
+
- [ ] New feature (non-breaking change which adds functionality)
|
7
|
+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
|
8
|
+
- [ ] Documentation update
|
9
|
+
- [ ] Code refactoring
|
10
|
+
- [ ] Performance improvement
|
11
|
+
- [ ] Other (please describe):
|
12
|
+
|
13
|
+
## Testing
|
14
|
+
- [ ] I have added tests that prove my fix is effective or that my feature works
|
15
|
+
- [ ] New and existing unit tests pass locally with my changes
|
16
|
+
- [ ] I have tested the CLI functionality manually
|
17
|
+
|
18
|
+
## Checklist
|
19
|
+
- [ ] My code follows the project's style guidelines
|
20
|
+
- [ ] I have performed a self-review of my code
|
21
|
+
- [ ] I have commented my code, particularly in hard-to-understand areas
|
22
|
+
- [ ] I have made corresponding changes to the documentation
|
23
|
+
- [ ] My changes generate no new warnings
|
24
|
+
|
25
|
+
## Screenshots (if applicable)
|
26
|
+
Add screenshots to help explain your changes.
|
27
|
+
|
28
|
+
## Additional Notes
|
29
|
+
Any additional information that would be helpful for reviewers.
|
@@ -0,0 +1,49 @@
|
|
1
|
+
# Security Policy
|
2
|
+
|
3
|
+
## Supported Versions
|
4
|
+
|
5
|
+
We actively support the following versions of db-drift:
|
6
|
+
|
7
|
+
| Version | Supported |
|
8
|
+
| ------- | ------------------ |
|
9
|
+
| 0.x.x | :white_check_mark: |
|
10
|
+
|
11
|
+
## Reporting a Vulnerability
|
12
|
+
|
13
|
+
If you discover a security vulnerability in db-drift, please report it to us responsibly.
|
14
|
+
|
15
|
+
### How to Report
|
16
|
+
|
17
|
+
1. **Do not create a public GitHub issue** for security vulnerabilities
|
18
|
+
2. **Email us directly** at: dyka3773@gmail.com
|
19
|
+
3. **Include the following information:**
|
20
|
+
- Description of the vulnerability
|
21
|
+
- Steps to reproduce
|
22
|
+
- Affected versions
|
23
|
+
- Potential impact
|
24
|
+
- Suggested fix (if available)
|
25
|
+
|
26
|
+
### Response Timeline
|
27
|
+
|
28
|
+
- **Acknowledgment**: We will acknowledge receipt of your report as soon as possible (usually within 48 hours)
|
29
|
+
- **Assessment**: We will assess the vulnerability within 7 days
|
30
|
+
- **Fix**: We will work on a fix and release it as soon as possible
|
31
|
+
- **Credit**: We will credit you in the security advisory (unless you prefer to remain anonymous)
|
32
|
+
|
33
|
+
### Security Best Practices
|
34
|
+
|
35
|
+
When using db-drift:
|
36
|
+
|
37
|
+
1. **Keep updated**: Always use the latest version
|
38
|
+
2. **Validate inputs**: Be cautious with dependency files from untrusted sources
|
39
|
+
3. **File permissions**: Ensure proper file permissions on generated outputs
|
40
|
+
4. **CI/CD**: Use in secure CI/CD environments
|
41
|
+
|
42
|
+
### Scope
|
43
|
+
|
44
|
+
This security policy applies to:
|
45
|
+
- The db-drift Python package
|
46
|
+
- Official GitHub repository
|
47
|
+
- Documentation and examples
|
48
|
+
|
49
|
+
Thank you for helping keep db-drift secure!
|
@@ -0,0 +1,39 @@
|
|
1
|
+
version: 2
|
2
|
+
updates:
|
3
|
+
# Enable version updates for Python dependencies
|
4
|
+
- package-ecosystem: "pip"
|
5
|
+
directory: "/"
|
6
|
+
schedule:
|
7
|
+
interval: "weekly"
|
8
|
+
open-pull-requests-limit: 10
|
9
|
+
commit-message:
|
10
|
+
prefix: "deps"
|
11
|
+
prefix-development: "deps-dev"
|
12
|
+
labels:
|
13
|
+
- "dependencies"
|
14
|
+
- "python"
|
15
|
+
|
16
|
+
- package-ecosystem: "uv"
|
17
|
+
directory: "/"
|
18
|
+
schedule:
|
19
|
+
interval: "weekly"
|
20
|
+
open-pull-requests-limit: 10
|
21
|
+
commit-message:
|
22
|
+
prefix: "deps"
|
23
|
+
prefix-development: "deps-dev"
|
24
|
+
labels:
|
25
|
+
- "dependencies"
|
26
|
+
- "uv"
|
27
|
+
- "python"
|
28
|
+
|
29
|
+
# Enable version updates for GitHub Actions
|
30
|
+
- package-ecosystem: "github-actions"
|
31
|
+
directory: "/"
|
32
|
+
schedule:
|
33
|
+
interval: "weekly"
|
34
|
+
open-pull-requests-limit: 5
|
35
|
+
commit-message:
|
36
|
+
prefix: "ci"
|
37
|
+
labels:
|
38
|
+
- "dependencies"
|
39
|
+
- "github-actions"
|
@@ -0,0 +1,35 @@
|
|
1
|
+
name: CI
|
2
|
+
|
3
|
+
on:
|
4
|
+
pull_request:
|
5
|
+
branches: [ main, develop ]
|
6
|
+
|
7
|
+
jobs:
|
8
|
+
test:
|
9
|
+
runs-on: ubuntu-latest
|
10
|
+
strategy:
|
11
|
+
matrix:
|
12
|
+
python-version: ["3.13"]
|
13
|
+
|
14
|
+
steps:
|
15
|
+
- uses: actions/checkout@v4
|
16
|
+
|
17
|
+
- name: Set up Python
|
18
|
+
uses: actions/setup-python@v5
|
19
|
+
|
20
|
+
- name: Install uv
|
21
|
+
uses: astral-sh/setup-uv@v6
|
22
|
+
with:
|
23
|
+
version: "latest"
|
24
|
+
|
25
|
+
- name: Install dependencies
|
26
|
+
run: uv sync --dev
|
27
|
+
|
28
|
+
- name: Install tox
|
29
|
+
run: uv tool install tox --with tox-uv
|
30
|
+
|
31
|
+
- name: Run linter & tests
|
32
|
+
run: tox --parallel
|
33
|
+
|
34
|
+
- name: Test CLI
|
35
|
+
run: uv run python -m db_drift --help
|
@@ -0,0 +1,60 @@
|
|
1
|
+
name: Semantic Release
|
2
|
+
|
3
|
+
on:
|
4
|
+
push:
|
5
|
+
branches: [ main ]
|
6
|
+
workflow_dispatch:
|
7
|
+
|
8
|
+
concurrency: ${{ github.workflow }}-${{ github.ref }}
|
9
|
+
|
10
|
+
jobs:
|
11
|
+
release:
|
12
|
+
runs-on: ubuntu-latest
|
13
|
+
permissions:
|
14
|
+
contents: write
|
15
|
+
id-token: write
|
16
|
+
issues: write
|
17
|
+
pull-requests: write
|
18
|
+
|
19
|
+
steps:
|
20
|
+
- name: Checkout
|
21
|
+
uses: actions/checkout@v4
|
22
|
+
with:
|
23
|
+
fetch-depth: 0
|
24
|
+
token: ${{ secrets.GITHUB_TOKEN }}
|
25
|
+
|
26
|
+
- name: Set up Python
|
27
|
+
uses: actions/setup-python@v5
|
28
|
+
with:
|
29
|
+
python-version: '3.13'
|
30
|
+
|
31
|
+
- name: Install uv
|
32
|
+
uses: astral-sh/setup-uv@v6
|
33
|
+
|
34
|
+
- name: Install dependencies
|
35
|
+
run: |
|
36
|
+
uv sync --dev
|
37
|
+
|
38
|
+
- name: Python Semantic Release
|
39
|
+
id: release
|
40
|
+
uses: python-semantic-release/python-semantic-release@v10.3.0
|
41
|
+
with:
|
42
|
+
github_token: ${{ secrets.GITHUB_TOKEN }}
|
43
|
+
|
44
|
+
- name: Generate Changelog
|
45
|
+
if: steps.release.outputs.released == 'true'
|
46
|
+
run: |
|
47
|
+
uv run git-changelog --output CHANGELOG.md --template keepachangelog
|
48
|
+
git config --local user.email "action@github.com"
|
49
|
+
git config --local user.name "GitHub Action"
|
50
|
+
git add CHANGELOG.md
|
51
|
+
git commit -m "docs: update changelog for ${{ steps.release.outputs.tag }}" || exit 0
|
52
|
+
git push
|
53
|
+
|
54
|
+
- name: Publish to PyPI
|
55
|
+
if: steps.release.outputs.released == 'true'
|
56
|
+
env:
|
57
|
+
TWINE_USERNAME: __token__
|
58
|
+
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
|
59
|
+
run: |
|
60
|
+
uv run twine upload dist/*
|
@@ -0,0 +1,207 @@
|
|
1
|
+
# Byte-compiled / optimized / DLL files
|
2
|
+
__pycache__/
|
3
|
+
*.py[cod]
|
4
|
+
*$py.class
|
5
|
+
|
6
|
+
# C extensions
|
7
|
+
*.so
|
8
|
+
|
9
|
+
# Distribution / packaging
|
10
|
+
.Python
|
11
|
+
build/
|
12
|
+
develop-eggs/
|
13
|
+
dist/
|
14
|
+
downloads/
|
15
|
+
eggs/
|
16
|
+
.eggs/
|
17
|
+
lib/
|
18
|
+
lib64/
|
19
|
+
parts/
|
20
|
+
sdist/
|
21
|
+
|
22
|
+
# Project specific - only ignore in root directory
|
23
|
+
/dependency_tree.txt
|
24
|
+
/maven_dependency_file
|
25
|
+
/diagram.html
|
26
|
+
/dependencies.json
|
27
|
+
/*.svg
|
28
|
+
|
29
|
+
var/
|
30
|
+
wheels/
|
31
|
+
share/python-wheels/
|
32
|
+
*.egg-info/
|
33
|
+
.installed.cfg
|
34
|
+
*.egg
|
35
|
+
MANIFEST
|
36
|
+
|
37
|
+
# PyInstaller
|
38
|
+
# Usually these files are written by a python script from a template
|
39
|
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
40
|
+
*.manifest
|
41
|
+
*.spec
|
42
|
+
|
43
|
+
# Installer logs
|
44
|
+
pip-log.txt
|
45
|
+
pip-delete-this-directory.txt
|
46
|
+
|
47
|
+
# Unit test / coverage reports
|
48
|
+
htmlcov/
|
49
|
+
.tox/
|
50
|
+
.nox/
|
51
|
+
.coverage
|
52
|
+
.coverage.*
|
53
|
+
.cache
|
54
|
+
nosetests.xml
|
55
|
+
coverage.xml
|
56
|
+
*.cover
|
57
|
+
*.py,cover
|
58
|
+
.hypothesis/
|
59
|
+
.pytest_cache/
|
60
|
+
cover/
|
61
|
+
|
62
|
+
# Translations
|
63
|
+
*.mo
|
64
|
+
*.pot
|
65
|
+
|
66
|
+
# Django stuff:
|
67
|
+
*.log
|
68
|
+
local_settings.py
|
69
|
+
db.sqlite3
|
70
|
+
db.sqlite3-journal
|
71
|
+
|
72
|
+
# Flask stuff:
|
73
|
+
instance/
|
74
|
+
.webassets-cache
|
75
|
+
|
76
|
+
# Scrapy stuff:
|
77
|
+
.scrapy
|
78
|
+
|
79
|
+
# Sphinx documentation
|
80
|
+
docs/_build/
|
81
|
+
|
82
|
+
# PyBuilder
|
83
|
+
.pybuilder/
|
84
|
+
target/
|
85
|
+
|
86
|
+
# Jupyter Notebook
|
87
|
+
.ipynb_checkpoints
|
88
|
+
|
89
|
+
# IPython
|
90
|
+
profile_default/
|
91
|
+
ipython_config.py
|
92
|
+
|
93
|
+
# pyenv
|
94
|
+
# For a library or package, you might want to ignore these files since the code is
|
95
|
+
# intended to run in multiple environments; otherwise, check them in:
|
96
|
+
# .python-version
|
97
|
+
|
98
|
+
# pipenv
|
99
|
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
100
|
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
101
|
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
102
|
+
# install all needed dependencies.
|
103
|
+
Pipfile.lock
|
104
|
+
|
105
|
+
# UV
|
106
|
+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
|
107
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
108
|
+
# commonly ignored for libraries.
|
109
|
+
#uv.lock
|
110
|
+
|
111
|
+
# poetry
|
112
|
+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
|
113
|
+
# This is especially recommended for binary packages to ensure reproducibility, and is more
|
114
|
+
# commonly ignored for libraries.
|
115
|
+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
|
116
|
+
poetry.lock
|
117
|
+
poetry.toml
|
118
|
+
|
119
|
+
# pdm
|
120
|
+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
|
121
|
+
pdm.lock
|
122
|
+
# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
|
123
|
+
# in version control.
|
124
|
+
# https://pdm.fming.dev/latest/usage/project/#working-with-version-control
|
125
|
+
.pdm.toml
|
126
|
+
.pdm-python
|
127
|
+
.pdm-build/
|
128
|
+
|
129
|
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
|
130
|
+
__pypackages__/
|
131
|
+
|
132
|
+
# Celery stuff
|
133
|
+
celerybeat-schedule
|
134
|
+
celerybeat.pid
|
135
|
+
|
136
|
+
# SageMath parsed files
|
137
|
+
*.sage.py
|
138
|
+
|
139
|
+
# Environments
|
140
|
+
.env
|
141
|
+
.venv
|
142
|
+
env/
|
143
|
+
venv/
|
144
|
+
ENV/
|
145
|
+
env.bak/
|
146
|
+
venv.bak/
|
147
|
+
|
148
|
+
# Spyder project settings
|
149
|
+
.spyderproject
|
150
|
+
.spyproject
|
151
|
+
|
152
|
+
# Rope project settings
|
153
|
+
.ropeproject
|
154
|
+
|
155
|
+
# mkdocs documentation
|
156
|
+
/site
|
157
|
+
|
158
|
+
# mypy
|
159
|
+
.mypy_cache/
|
160
|
+
.dmypy.json
|
161
|
+
dmypy.json
|
162
|
+
|
163
|
+
# Pyre type checker
|
164
|
+
.pyre/
|
165
|
+
|
166
|
+
# pytype static type analyzer
|
167
|
+
.pytype/
|
168
|
+
|
169
|
+
# Cython debug symbols
|
170
|
+
cython_debug/
|
171
|
+
|
172
|
+
# PyCharm
|
173
|
+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
|
174
|
+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
|
175
|
+
# and can be added to the global gitignore or merged into this file. For a more nuclear
|
176
|
+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
|
177
|
+
.idea/
|
178
|
+
|
179
|
+
# Abstra
|
180
|
+
# Abstra is an AI-powered process automation framework.
|
181
|
+
# Ignore directories containing user credentials, local state, and settings.
|
182
|
+
# Learn more at https://abstra.io/docs
|
183
|
+
.abstra/
|
184
|
+
|
185
|
+
# Visual Studio Code
|
186
|
+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
|
187
|
+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
|
188
|
+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
|
189
|
+
# you could uncomment the following to ignore the entire vscode folder
|
190
|
+
.vscode/*
|
191
|
+
!.vscode/settings.json
|
192
|
+
!.vscode/tasks.json
|
193
|
+
!.vscode/launch.json
|
194
|
+
!.vscode/extensions.json
|
195
|
+
!.vscode/*.code-snippets
|
196
|
+
!*.code-workspace
|
197
|
+
|
198
|
+
# Ruff stuff:
|
199
|
+
.ruff_cache/
|
200
|
+
|
201
|
+
# PyPI configuration file
|
202
|
+
.pypirc
|
203
|
+
|
204
|
+
# Database journal files
|
205
|
+
*.db-journal
|
206
|
+
*.db-journal-*
|
207
|
+
*.sqlite3-journal
|
@@ -0,0 +1 @@
|
|
1
|
+
3.13
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Changelog
|
2
|
+
|
3
|
+
All notable changes to this project will be documented in this file.
|
4
|
+
|
5
|
+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
6
|
+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
7
|
+
|
8
|
+
<!-- insertion marker -->
|
@@ -0,0 +1,122 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
We as members, contributors, and leaders pledge to make participation in our
|
6
|
+
community a harassment-free experience for everyone, regardless of age, body
|
7
|
+
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
8
|
+
identity and expression, level of experience, education, socio-economic status,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity
|
10
|
+
and orientation.
|
11
|
+
|
12
|
+
We pledge to act and interact in ways that are professional, respectful, and
|
13
|
+
considerate of the diverse experiences and perspectives of all participants.
|
14
|
+
|
15
|
+
## Our Standards
|
16
|
+
|
17
|
+
Examples of behavior that contributes to a positive environment for our
|
18
|
+
community include:
|
19
|
+
|
20
|
+
* Demonstrating empathy and kindness toward other people
|
21
|
+
* Being respectful of differing opinions, viewpoints, and experiences
|
22
|
+
* Giving and gracefully accepting constructive feedback
|
23
|
+
* Accepting responsibility and apologizing to those affected by our mistakes,
|
24
|
+
and learning from the experience
|
25
|
+
* Focusing on what is best not just for us as individuals, but for the
|
26
|
+
overall community
|
27
|
+
|
28
|
+
Examples of unacceptable behavior include:
|
29
|
+
|
30
|
+
* The use of sexualized language or imagery, and sexual attention or
|
31
|
+
advances of any kind
|
32
|
+
* Trolling, insulting or derogatory comments, and personal or political attacks
|
33
|
+
* Public or private harassment
|
34
|
+
* Publishing others' private information, such as a physical or email
|
35
|
+
address, without their explicit permission
|
36
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
37
|
+
professional setting
|
38
|
+
|
39
|
+
## Enforcement Responsibilities
|
40
|
+
|
41
|
+
Community leaders are responsible for clarifying and enforcing our standards of
|
42
|
+
acceptable behavior and will take appropriate and fair corrective action in
|
43
|
+
response to any behavior that they deem inappropriate, threatening, offensive,
|
44
|
+
or harmful.
|
45
|
+
|
46
|
+
Community leaders have the right and responsibility to remove, edit, or reject
|
47
|
+
comments, commits, code, wiki edits, issues, and other contributions that are
|
48
|
+
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
49
|
+
decisions when appropriate.
|
50
|
+
|
51
|
+
## Scope
|
52
|
+
|
53
|
+
This Code of Conduct applies within all community spaces, and also applies when
|
54
|
+
an individual is officially representing the community in public spaces.
|
55
|
+
Examples of representing our community include using an official e-mail address,
|
56
|
+
posting via an official social media account, or acting as an appointed
|
57
|
+
representative at an online or offline event.
|
58
|
+
|
59
|
+
## Enforcement
|
60
|
+
|
61
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
62
|
+
reported to the community leaders responsible for enforcement at
|
63
|
+
[INSERT CONTACT METHOD].
|
64
|
+
All complaints will be reviewed and investigated promptly and fairly.
|
65
|
+
|
66
|
+
All community leaders are obligated to respect the privacy and security of the
|
67
|
+
reporter of any incident.
|
68
|
+
|
69
|
+
## Enforcement Guidelines
|
70
|
+
|
71
|
+
Community leaders will follow these Community Impact Guidelines in determining
|
72
|
+
the consequences for any action they deem in violation of this Code of Conduct:
|
73
|
+
|
74
|
+
### 1. Correction
|
75
|
+
|
76
|
+
**Community Impact**: Use of inappropriate language or other behavior deemed
|
77
|
+
unprofessional or unwelcome in the community.
|
78
|
+
|
79
|
+
**Consequence**: A private, written warning from community leaders, providing
|
80
|
+
clarity around the nature of the violation and an explanation of why the
|
81
|
+
behavior was inappropriate. A public apology may be requested.
|
82
|
+
|
83
|
+
### 2. Warning
|
84
|
+
|
85
|
+
**Community Impact**: A violation through a single incident or series
|
86
|
+
of actions.
|
87
|
+
|
88
|
+
**Consequence**: A warning with consequences for continued behavior. No
|
89
|
+
interaction with the people involved, including unsolicited interaction with
|
90
|
+
those enforcing the Code of Conduct, for a specified period of time. This
|
91
|
+
includes avoiding interaction in community spaces as well as external channels
|
92
|
+
like social media. Violating these terms may lead to a temporary or
|
93
|
+
permanent ban.
|
94
|
+
|
95
|
+
### 3. Temporary Ban
|
96
|
+
|
97
|
+
**Community Impact**: A serious violation of community standards, including
|
98
|
+
sustained inappropriate behavior.
|
99
|
+
|
100
|
+
**Consequence**: A temporary ban from any sort of interaction or public
|
101
|
+
communication with the community for a specified period of time. No public or
|
102
|
+
private interaction with the people involved, including unsolicited interaction
|
103
|
+
with those enforcing the Code of Conduct, is allowed during this period.
|
104
|
+
Violating these terms may lead to a permanent ban.
|
105
|
+
|
106
|
+
### 4. Permanent Ban
|
107
|
+
|
108
|
+
**Community Impact**: Demonstrating a pattern of violation of community
|
109
|
+
standards, including sustained inappropriate behavior, harassment of an
|
110
|
+
individual, or aggression toward or disparagement of classes of individuals.
|
111
|
+
|
112
|
+
**Consequence**: A permanent ban from any sort of public interaction within the
|
113
|
+
community.
|
114
|
+
|
115
|
+
## Attribution
|
116
|
+
|
117
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
118
|
+
version 2.1, available at
|
119
|
+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
120
|
+
|
121
|
+
[homepage]: https://www.contributor-covenant.org
|
122
|
+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|