Thanks to visit codestin.com
Credit goes to github.com

Skip to content
This repository was archived by the owner on Jul 2, 2024. It is now read-only.

[Stable Release] Documentation release #38

Draft
wants to merge 713 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
713 commits
Select commit Hold shift + click to select a range
1652065
Remove previous documents from toctree (require updates)
shorodilov Nov 16, 2023
d927e15
Add structure overview document (fixes #73)
shorodilov Nov 16, 2023
fd0bd5e
Append table example
shorodilov Nov 16, 2023
7d817b9
Add DDL and DML drafts
shorodilov Nov 16, 2023
87209ff
Add create role statement description (GH-78)
shorodilov Nov 16, 2023
99b3a5a
Add create database statement section (GH-78)
shorodilov Nov 16, 2023
eb70ac8
Add note to tables descriptions
shorodilov Nov 16, 2023
35522fa
Add contents to DDL document
shorodilov Nov 16, 2023
a9be4ad
Add create table statement section (GH-78)
shorodilov Nov 16, 2023
ce13c8e
Add default value section (GH-78)
shorodilov Nov 16, 2023
f60a1c3
Add generated columns section (GH-78)
shorodilov Nov 16, 2023
9f07594
Add constraints section (GH-78)
shorodilov Nov 16, 2023
3983488
Add contents directive to GH-78 and GH-79
shorodilov Nov 16, 2023
9b58666
Fix identation in DDL (GH-78)
shorodilov Nov 16, 2023
ff357cc
Add insert data section draft (GH-79)
shorodilov Nov 18, 2023
25f7854
Add insert data section description and examples (GH-79)
shorodilov Nov 19, 2023
5fb35bb
Update insert data section (GH-79)
shorodilov Nov 19, 2023
1603576
Update insert data section (GH-79)
shorodilov Nov 19, 2023
58cc4b7
Add update data section (GH-79)
shorodilov Nov 19, 2023
275453b
Add remove data section (GH-79)
shorodilov Nov 19, 2023
91c5a4e
Add returning clause description (fixes GH-79)
shorodilov Nov 19, 2023
8ef4576
Add from clause description (GH-138)
shorodilov Nov 19, 2023
67b8f17
Add where clause description (GH-138)
shorodilov Nov 19, 2023
b6c671c
Add brief group by and having clauses description (GH-138)
shorodilov Nov 19, 2023
0225567
Move queries to a dedicated document (GH-138, GH-79)
shorodilov Nov 19, 2023
adc2173
Add select lists subsection (GH-138)
shorodilov Nov 19, 2023
888f063
Add column labels (GH-138)
shorodilov Nov 19, 2023
2511028
Add distinct description (GH-138)
shorodilov Nov 19, 2023
1cfe841
Update distinct section (GH-138)
shorodilov Nov 19, 2023
c767681
Add combining queries draft (GH-138)
shorodilov Nov 19, 2023
cbc4232
Complete combining queries section (GH-138)
shorodilov Nov 19, 2023
06678d1
Update markups (GH-138)
shorodilov Nov 19, 2023
9cbca02
Add meta for RDBMS documents
shorodilov Nov 19, 2023
00f85d7
Add sorting rows section (GH-138)
shorodilov Nov 19, 2023
2e70b23
Add WITH section (draft) (GH-138)
shorodilov Nov 19, 2023
55d510b
Update library database submodule
shorodilov Nov 19, 2023
4e82817
Add data types document (GH-82)
shorodilov Nov 19, 2023
5b2d743
Update RDBMS toctree
shorodilov Nov 19, 2023
d779e6d
Remove outdated RDBMS assets
shorodilov Nov 19, 2023
3c19877
Add numeric types ranges (GH-82)
shorodilov Nov 19, 2023
0c39669
Update PostgreSQL image
shorodilov Nov 19, 2023
463f8a7
Add system columns rubric (GH-78)
shorodilov Nov 19, 2023
3eebeb4
Add character types section (GH-82)
shorodilov Nov 19, 2023
02ee2bd
Add date/time types (GH-82)
shorodilov Nov 19, 2023
b7b2996
Add time zones and special date/time inputs tables (GH-82)
shorodilov Nov 19, 2023
ef54972
Add todos to data types document
shorodilov Nov 19, 2023
3414adc
Fix typos within RDBMS documents
shorodilov Nov 20, 2023
903dfd8
Update library database submodule
shorodilov Nov 20, 2023
9a70898
Add primary key description (GH-135)
shorodilov Nov 20, 2023
3fb1a47
Update foreign key description and remove relationship sections (GH-135)
shorodilov Nov 20, 2023
2210106
Complete foreign key section (GH-135)
shorodilov Nov 20, 2023
56a9fb7
Update library database submodule
shorodilov Nov 20, 2023
8597c53
fixup! Update library database submodule
shorodilov Nov 20, 2023
d294912
Update SQL snippets (GH-135)
shorodilov Nov 20, 2023
08d1402
Add relation section (fixes GH-135)
shorodilov Nov 20, 2023
e9922d2
Add select processing description (GH-138)
shorodilov Nov 20, 2023
7043185
Add joins section draft (GH-138)
shorodilov Nov 20, 2023
c45e030
Add with clauses subsections and usage examples (GH-138)
shorodilov Nov 21, 2023
ceeca03
Add general join overview (GH-135)
shorodilov Nov 21, 2023
a80a7c7
Fix ident and markup in "query" document (GH-138)
shorodilov Nov 21, 2023
2ea9409
Complete joins section (fixes GH-138)
shorodilov Nov 21, 2023
0f56c61
Remove duplicated join sections
shorodilov Nov 21, 2023
3d07cc3
Adjust markup
shorodilov Nov 21, 2023
7fc345c
Update code snippet
shorodilov Nov 21, 2023
33c1d05
Update document structure and combining queries examples (GH-138)
shorodilov Nov 21, 2023
a14cde5
Add intervals subsection (GH-82)
shorodilov Nov 21, 2023
1ebc2bd
Add boolean type section (GH-82)
shorodilov Nov 21, 2023
b81f7a9
Add enums section (GH-82)
shorodilov Nov 21, 2023
b635f3f
Clean-up todos in data types document (fixes GH-82)
shorodilov Nov 21, 2023
24bb32b
Add simple type cast syntax (fixes GH-84)
shorodilov Nov 21, 2023
40221b7
Add postgres install appendix document (GH-80)
shorodilov Nov 21, 2023
f6256c1
Add local postgres deployment using binaries document (GH-80)
shorodilov Nov 21, 2023
ddc6591
Add hidden title to pg_local appendix (GH-80)
shorodilov Nov 22, 2023
1ead4b8
Add postgres overview to appendix document (GH-80)
shorodilov Nov 22, 2023
2296c9d
Add postgres install links (fixes GH-80)
shorodilov Nov 22, 2023
1149bb4
Add modifying objects section (GH-78)
shorodilov Nov 22, 2023
6406609
Complete dropping objects section (fixes GH-78)
shorodilov Nov 22, 2023
c127e0f
Add functions and operators document draft (GH-83)
shorodilov Nov 22, 2023
56b6072
Add logical operators subsection (GH-83)
shorodilov Nov 22, 2023
6b1dda0
Add comparison operators and comparison predicates subsections (GH-83)
shorodilov Nov 22, 2023
a28ccee
Add comparison functions (GH-83)
shorodilov Nov 22, 2023
99d9c14
Minor fixes to comparison predicates subsection (GH-83)
shorodilov Nov 22, 2023
c007c77
Update comparison predicates subsection (GH-83)
shorodilov Nov 22, 2023
951f860
Update headers (GH-83)
shorodilov Nov 22, 2023
815aae3
Add math operators (GH-83)
shorodilov Nov 22, 2023
a8d90f2
Move comparison and match operators details to appendix document (GH-83)
shorodilov Nov 22, 2023
0af419e
Add match operators (GH-83)
shorodilov Nov 22, 2023
8fc93b5
Update headers and todos in functions document (GH-83)
shorodilov Nov 22, 2023
9cbef9b
Update bibliography (GH-53, GH-136)
shorodilov Nov 22, 2023
1b5d483
Add avg and count functions subsections (GH-83)
shorodilov Nov 23, 2023
b01d89a
Fix "env_path" appx - was changed by mistake
shorodilov Nov 23, 2023
ec9b3c3
Add max, min and sum functions subsections (GH-83)
shorodilov Nov 23, 2023
bfcf409
Update aggregation functions examples (GH-83)
shorodilov Nov 23, 2023
6e31615
Update aggregation functions signatures as per off. docs (GH-83)
shorodilov Nov 23, 2023
ddc5a62
Remove outdated aggregate.txt document (GH-83)
shorodilov Nov 23, 2023
4e7fbf1
Update avg function subsection (GH-83)
shorodilov Nov 23, 2023
1f28f7c
Fix minor documentation generator errors
shorodilov Nov 24, 2023
0485dbe
Merge remote-tracking branch 'upstream/master'
shorodilov Nov 26, 2023
9e2cb64
Merge branch 'master' into master
shorodilov Nov 26, 2023
24b58e8
Add gift-giver specification
shorodilov Dec 1, 2023
5510137
Add pre-translated (DeepL) localization for gift-giver specification
shorodilov Dec 2, 2023
7a6af38
[giver-spec] Complete proofread for translation
shorodilov Dec 2, 2023
2c57f42
Merge branch 'devel' into feature/rdbms
shorodilov Dec 2, 2023
b746356
Merge remote-tracking branch 'origin/devel' into feature/rdbms
shorodilov Dec 2, 2023
bfb695a
Add conditional expressions (GH-83)
shorodilov Dec 3, 2023
e87f4d8
Add string functions and operators (GH-83)
shorodilov Dec 3, 2023
ac60add
Add pattern matching (GH-83)
shorodilov Dec 3, 2023
79a887b
Add extract/date_part section (GH-83)
shorodilov Dec 3, 2023
20404fc
Add current date/time functions (GH-83)
shorodilov Dec 3, 2023
08852c8
Add formatting functions (GH-83)
shorodilov Dec 3, 2023
9ee2a98
Update normalization document (GH-136)
shorodilov Dec 3, 2023
1d6821a
Add normalized tables pros (GH-136)
shorodilov Dec 3, 2023
08e8e05
Add notes for 1-3NF and conclusion section draft (GH-136)
shorodilov Dec 3, 2023
59fdb12
Add normal form requirements (1NF, 2NF, 3NF, BCNF) (GH-136)
shorodilov Dec 3, 2023
3ee47e7
Add anomalies section draft (GH-136)
shorodilov Dec 3, 2023
5dd64d3
Apply minor fixes to documentation (GH-136)
shorodilov Dec 3, 2023
e5efb46
Add toml package to project dependencies
shorodilov Dec 21, 2023
17e84c8
Add pre-translated locale file
shorodilov Dec 21, 2023
0151465
Merge branch 'devel' into feature/rdbms
shorodilov Dec 21, 2023
4adfbda
Update blog specification submodule
shorodilov Nov 17, 2023
9f9f87a
Update blog specification translations
shorodilov Nov 17, 2023
fea10a7
Merge branch 'devel' into feature/rdbms
shorodilov Dec 21, 2023
ff6f039
[GH-Actions] Update test build config (#148)
shorodilov Dec 22, 2023
f54cd54
Merge branch 'devel' into feature/rdbms
shorodilov Dec 22, 2023
4e66674
Apply translation proofreading - rdbms/appx
shorodilov Dec 22, 2023
1cce0a0
Apply translation proofreading - rdbms/datatypes
shorodilov Dec 22, 2023
8371154
Update translation (pre-translated) - rdbms/ddl
shorodilov Dec 22, 2023
f293cb1
Update project version in translation files
shorodilov Dec 22, 2023
9409a2d
[RDBMS] Relational database and PostgreSQL part (#134)
shorodilov Dec 22, 2023
0585c62
Update submodules from remotes
shorodilov Dec 26, 2023
cdab2ef
Add legacy directories to the documentation builder exclude patterns
shorodilov Dec 26, 2023
f6f4db8
Add redirects support for the documentation builder
shorodilov Dec 26, 2023
447508c
Move specification submodules to spec directory
shorodilov Dec 26, 2023
e798bfc
Set up redirects (fixes GH-139)
shorodilov Dec 26, 2023
e4eca81
Update project dependencies
shorodilov Dec 26, 2023
f299dec
Move specification translations (fixes GH-139)
shorodilov Dec 26, 2023
02ea7df
Delete outdated translations
shorodilov Dec 26, 2023
0e5dc42
Update printf appendix
shorodilov Dec 26, 2023
62575d5
[Submodules] Move specification submodules to spec directory (#174)
shorodilov Dec 26, 2023
186214d
Remove separate PDF documents builds config
shorodilov Dec 26, 2023
55e39f7
Add CONTRIBUTING.rst guides (draft)
shorodilov Jul 31, 2023
b0cd671
Add "CONTRIBUTING" reference to "README" file.
shorodilov Aug 21, 2023
34acae4
Add todos to contributing document
shorodilov Aug 21, 2023
8a63ee3
Update CONTRIBUTING.rst (no todos!)
shorodilov Aug 22, 2023
b48ab87
Add headings description
shorodilov Aug 22, 2023
60e6ca5
Add "build without make" subsection
shorodilov Aug 24, 2023
496ee63
Update CONTRIBUTING.rst
shorodilov Aug 24, 2023
661d57b
Update CONTRIBUTING.rst
shorodilov Aug 24, 2023
147edf7
Update documentation description section in contributing guide document
shorodilov Dec 27, 2023
fb37e1f
Add submodules section to contributing document
shorodilov Dec 28, 2023
f80666f
Add code of conduct document template
shorodilov Dec 28, 2023
034262f
Add poedit short description
shorodilov Dec 28, 2023
477df05
Add guide on how to add new documents to the repo
shorodilov Dec 28, 2023
7eae18b
Add guide on how to add new topics
shorodilov Dec 28, 2023
e73a6fe
Fix poedit link
shorodilov Dec 28, 2023
442b616
Add guide on how to prepare translations
shorodilov Dec 28, 2023
3857373
Add contributing guide and code of conduct (#86)
shorodilov Dec 28, 2023
d59cabf
Add markdown version of code of conduct document
shorodilov Dec 28, 2023
468098a
Add markdown version of contributing document
shorodilov Dec 28, 2023
9260c65
Update linux intro image
shorodilov Jan 6, 2024
fd9c598
Update linux intro image (#178)
shorodilov Jan 6, 2024
b1f059a
Update submodules
shorodilov Jan 8, 2024
15db8ed
Add yEd graph editor mention to the software list appendix
shorodilov Dec 28, 2023
057c40c
Update translations (Ukrainian)
shorodilov Jan 8, 2024
e1d3c7b
Update specifications submodules
shorodilov Jan 8, 2024
2371ec4
Add png versions of mermaid diagrams
shorodilov Jan 8, 2024
7a11a78
Change mermaid diagrams to their png versions for the PDF builder
shorodilov Jan 8, 2024
b61cf7d
Update SVG assets
shorodilov Jan 9, 2024
442b6aa
Setup Inkscape as svg converter for pdf builder
shorodilov Jan 9, 2024
d767294
Update translations (Ukrainian)
shorodilov Jan 9, 2024
342f845
Fixes GH-115
shorodilov Jan 9, 2024
085a6ea
[PDF docs] Add PDF documentation generator (#181)
shorodilov Jan 9, 2024
6e42c5b
Update software list (#179)
shorodilov Jan 22, 2024
ec9ce8c
Merge branch 'master' into devel
shorodilov Jan 29, 2024
13354a2
Fixes GH-184
shorodilov Jan 29, 2024
5d63737
Merge remote-tracking branch 'origin/master' into devel
shorodilov Jan 29, 2024
c4409e2
Change project version and update dependencies (2024.02.dev)
shorodilov Feb 18, 2024
d6601b3
(GH-136) Complete anomalies sections
shorodilov Feb 18, 2024
1f22185
(GH-136) Complete 1NF section
shorodilov Feb 18, 2024
e85da3a
(GH-136) Complete 2NF section
shorodilov Feb 18, 2024
9a5f957
(GH-136) Complete 3NF section
shorodilov Feb 18, 2024
170197e
Complete conclusion (fixes GH-136)
shorodilov Feb 18, 2024
0dbfb9f
(GH-53) Add ACID document draft
shorodilov Feb 18, 2024
9f8df5a
(GH-53) Add atomicity section
shorodilov Feb 18, 2024
a43c164
(GH-53) Add consistency section
shorodilov Feb 18, 2024
b8983e1
(GH-53) Add isolation section
shorodilov Feb 18, 2024
3f161bd
Add durability section (fixes GH-53)
shorodilov Feb 18, 2024
6e9500e
Fix normalization doc tables captions
shorodilov Feb 18, 2024
18b4869
Add ACID chapter translation (GH-146)
shorodilov Feb 18, 2024
1c5db34
Add normalization doc translation (GH-146)
shorodilov Feb 18, 2024
db6ff27
Fixes GH-146
shorodilov Feb 18, 2024
a882d09
Merge updates from the upstream repo into devel branch (#188)
shorodilov Feb 20, 2024
83fabc9
Update submodules meta
shorodilov Feb 22, 2024
277749d
[RDBMS] Complete database documentation part (#186)
shorodilov Feb 24, 2024
947cd95
Add impress.js (presentation framework) submodule (fixes GH-207)
shorodilov Feb 23, 2024
c8e5e1c
GH-202: Add normalization topic mindmap
shorodilov Feb 23, 2024
32d2f66
GH-202: Add presentation draft
shorodilov Feb 23, 2024
432aaf0
Set up presentations builder (fixes GH-208)
shorodilov Feb 24, 2024
461c3a2
GH-202: Update anomalies slides
shorodilov Feb 24, 2024
72be9ac
GH-202: Add normal forms requirements
shorodilov Feb 24, 2024
5b34f15
GH-202: Add anomalies notes
shorodilov Feb 25, 2024
47a19b0
GH-202: Add applying 1NF steps
shorodilov Feb 25, 2024
5c18be0
GH-202: Update steps identifiers
shorodilov Feb 25, 2024
e5e726a
GH-202: Add applying 2NF steps
shorodilov Feb 25, 2024
834f73c
GH-202: Add ids to data tables rows
shorodilov Feb 25, 2024
c2b4449
GH-202: Add applying 3NF steps
shorodilov Feb 25, 2024
c18bd8e
GH-202: Adjust presentation data
shorodilov Feb 25, 2024
f9bf8ee
GH-202: Add fallback message
shorodilov Feb 25, 2024
2a0a3af
GH-202: Add styles and complete 1NF presentation steps
shorodilov Feb 25, 2024
509ba9d
GH-202: Add steps description comments
shorodilov Feb 25, 2024
4a3b2b3
GH-202: Add 2NF and 3NF drafts
shorodilov Feb 25, 2024
52f5bce
GH-202: Add 3NF transitions
shorodilov Feb 26, 2024
8b112f6
GH-202: Add 2NF transitions
shorodilov Feb 26, 2024
75370b5
GH-202: Add 1NF transitions
shorodilov Feb 26, 2024
b9cadc5
GH-202: Add deletion anomalies transitions
shorodilov Feb 26, 2024
b4a4e30
GH-202: Add update anomalies transitions
shorodilov Feb 26, 2024
77b49ea
GH-202: Add insertion anomalies transitions
shorodilov Feb 26, 2024
19c8118
GH-202: Fix deletion anomalies transitions
shorodilov Feb 26, 2024
4e2227c
GH-202: Add test pass/fail marks and update transitions
shorodilov Feb 26, 2024
d778135
Move normalization presentation to rdbms sources (fixes GH-202)
shorodilov Feb 26, 2024
affd390
CI: Update test build workflow
shorodilov Feb 26, 2024
ad0529d
CI: Update test build workflow
shorodilov Feb 26, 2024
8e5c195
CD: Add presentations to gh-pages deployment package
shorodilov Feb 26, 2024
e41101b
CD: Add presentations to gh-pages deployment package
shorodilov Feb 26, 2024
287d533
[Presentation] Add normalization presentation (#210)
shorodilov Feb 26, 2024
6e92fec
Add MT for rdbms relationship doc
shorodilov Feb 26, 2024
c8f5654
Rename presentations directory (rdbms; patch GH-202)
shorodilov Feb 27, 2024
120434a
Disable automated deployment to GitHub pages (fixes GH-217)
shorodilov Feb 29, 2024
094a283
[Presentation] Database normalization (w/o styling) (#223)
shorodilov Mar 4, 2024
049ea2f
Rename db normalization mindmap document
shorodilov Mar 4, 2024
b0157c6
Add Django introduction mindmap doc (GH-221)
shorodilov Mar 4, 2024
ca84b1d
Update db normalization mindmap (GH-202)
shorodilov Mar 4, 2024
aff2d21
Add ACID mindmap (GH-206)
shorodilov Mar 4, 2024
373b50d
Add functions mindmap (GH-216)
shorodilov Mar 4, 2024
b0b7716
Update functions mindmap (GH-216)
shorodilov Mar 4, 2024
89533cf
Add DTL mindmap (GH-89, GH-224)
shorodilov Mar 4, 2024
14f323e
Add Django models mindmap (GH-90, GH-225)
shorodilov Mar 4, 2024
38154bf
Update Django models mindmap (GH-90, GH-225)
shorodilov Mar 4, 2024
b6b1030
Update Django models mindmap (GH-90, GH-225)
shorodilov Mar 4, 2024
70f3838
Add RDBMS relationships mindmap
shorodilov Mar 5, 2024
18fd2f9
[Mindmaps] Add mindmaps for the course contents (#227)
shorodilov Mar 5, 2024
53aa6db
Update submodules
shorodilov Mar 5, 2024
28a620b
Update project version and dependencies
shorodilov Mar 5, 2024
b6ced0f
Merge branch 'hotfix/rdbms' into 2024.03.1
shorodilov Mar 5, 2024
c1f0810
Update translations (Ukrainian)
shorodilov Mar 5, 2024
1a390b7
Update translations (Ukrainian) (fixes GH-212, fixes GH-213, fixes GH…
shorodilov Mar 5, 2024
0916838
Update refs
shorodilov Mar 5, 2024
d138033
Minor fixes to Git part documents
shorodilov Mar 8, 2024
b12c27b
Make transparent background for mermaid pngs
shorodilov Mar 8, 2024
34436c5
[2024.03.1] RDBMS part update (#228)
shorodilov Mar 21, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .github/CODEOWNERS
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/src/basics/ @shorodilov @Bandydan @Jules57
/src/vcs/ @shorodilov @Bandydan
/src/rdbms/ @shorodilov @Bandydan
/src/oop/ @shorodilov
/src/django/ @PonomaryovVladyslav @shorodilov
/src/deploy/ @PonomaryovVladyslav @shorodilov
77 changes: 77 additions & 0 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our
project and our community a harassment-free experience for everyone,
regardless of age, body size, disability, ethnicity, gender identity and
expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual
attention or advances
- Trolling, insulting/derogatory comments, and personal or political
attacks
- Public or private harassment
- Publishing others' private information, such as a physical or
electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in
a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of
acceptable behavior and are expected to take appropriate and fair
corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit,
or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct, or to ban
temporarily or permanently any contributor for other behaviors that they
deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public
spaces when an individual is representing the project or its community.
Examples of representing a project or community include using an
official project e-mail address, posting via an official social media
account, or acting as an appointed representative at an online or
offline event. Representation of a project may be further defined and
clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported by contacting the project team at {{ email }}. All
complaints will be reviewed and investigated and will result in a
response that is deemed necessary and appropriate to the circumstances.
The project team is obligated to maintain confidentiality with regard to
the reporter of an incident. Further details of specific enforcement
policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in
good faith may face temporary or permanent repercussions as determined
by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor
Covenant](https://www.contributor-covenant.org), version 1.4, available
at
<https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>
84 changes: 84 additions & 0 deletions .github/CODE_OF_CONDUCT.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
Contributor Covenant Code of Conduct
====================================

Our Pledge
----------

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our
project and our community a harassment-free experience for everyone,
regardless of age, body size, disability, ethnicity, gender identity and
expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

Our Standards
-------------

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual
attention or advances
- Trolling, insulting/derogatory comments, and personal or political
attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or
electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

Our Responsibilities
--------------------

Project maintainers are responsible for clarifying the standards of
acceptable behavior and are expected to take appropriate and fair
corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit,
or reject comments, commits, code, wiki edits, issues, and other
contributions that are not aligned to this Code of Conduct, or to ban
temporarily or permanently any contributor for other behaviors that they
deem inappropriate, threatening, offensive, or harmful.

Scope
-----

This Code of Conduct applies both within project spaces and in public
spaces when an individual is representing the project or its community.
Examples of representing a project or community include using an
official project e-mail address, posting via an official social media
account, or acting as an appointed representative at an online or
offline event. Representation of a project may be further defined and
clarified by project maintainers.

Enforcement
-----------

Instances of abusive, harassing, or otherwise unacceptable behavior may
be reported by contacting the project team at {{ email }}. All
complaints will be reviewed and investigated and will result in a
response that is deemed necessary and appropriate to the circumstances.
The project team is obligated to maintain confidentiality with regard to
the reporter of an incident. Further details of specific enforcement
policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in
good faith may face temporary or permanent repercussions as determined
by other members of the project’s leadership.

Attribution
-----------

This Code of Conduct is adapted from the `Contributor
Covenant <https://www.contributor-covenant.org>`__, version 1.4,
available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
Loading