Merge remote-tracking branch 'origin/main' into 29-chapter-terminology

.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,34 @@
+---
+name: Bug
+about: Create a report to help improve the project's infrastructure
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+A bug should describe an infrastructure problem, for example: LaTeX reports an error, the virtualized environment fails etc.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment (please complete the following information):**
+ - OS: [e.g. iOS]
+-  Virtualization [e.g. None or Docker]
+ - LaTeX distribution [e.g. TexLive]
+ - Document version [e.g. 13.0.10.8.13]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/suggestion.md

@@ -0,0 +1,26 @@
+---
+name: Suggestion
+about: Create a suggestion to improve and enhance the document itself
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Describe the suggestion**
+A short summary what kind of content you'd like to change.
+
+**Changes in existing chapter ABC**
+Either refer to the PDF page number or the chapter you'd like to address.
+Cite the original text and add your comments or changes below it.
+
+**New text, new chapter etc.**
+If you'd like to see a new chapter with some more exiting content, great!
+Please write down what kind of chapter you think could help improving the project.
+Any kind of suggestion, like keywords, notes or even prewritten texts would be of great help here.
+Please add also where inside the document the new chapter should be arranged.
+
+**Scientific sources**
+If you can, please add a scientific source like a paper, book or some other kind of source.
+This helps to decide how the suggestion can be integrated.
+It might be useful to provide the source if necessary so that a reviewer can understand the suggestion and act upon it.

.github/pull_request_template.md

@@ -0,0 +1,26 @@
+# Description
+
+Please include a summary of the change and which issue is fixed. 
+Please also include relevant motivation and context. 
+List any dependencies that are required for this change.
+
+Addresses # (issue)
+
+## Type of change
+
+Please delete options that are not relevant.
+
+- [ ] Bug fix (fixes issues with the infrastructure)
+- [ ] New content (non-breaking change which adds new content)
+- [ ] Breaking change (major refactoring which changes many aspects like whole chapters etc.)
+- [ ] This change requires a documentation update
+- [ ] Requires changelog update
+
+# Checklist:
+
+- [ ] My code follows the style guidelines of this project
+- [ ] I have performed a self-review of my own code
+- [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] I have made corresponding changes to the documentation
+- [ ] All external files (like images, photos) are granted to be used and marked accordingly
+- [ ] I checked all newly cited sources

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,73 @@
+# Ways of contribution
+Your input is more than welcome! Contributing to this project should be as easy and transparent 
+as possible, whether it's:
+
+* Reporting problems
+* Discussing the current state of the document
+* Suggesting changes
+* Proposing new parts, be it chapters, sections or small additions.
+
+## Developing with GitHub
+This project uses GitHub to host code, to track issues and feature requests, utilize pull requests
+to ensure reviews and continuous integration.
+
+## Releases
+The document itself will never really be completed as the decipherment is an ongoing 
+process with no foreseeable ending.
+Therefore, there will be a continuous stream of releases once in a while.
+Please see chapter [Release](documentation/releases.md)
+for some more detailed information.
+
+## All changes happen through pull requests (PR)
+Pull requests are the best way to propose changes to the codebase.
+Please see chapter [Continuous Integration](documentation/continuous-integration.md)
+for some more detailed information.
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit changes, your submissions are understood to be under the same 
+[MIT License](LICENSE) that covers the project. 
+Feel free to contact the maintainers if that's a concern.
+
+## Report problems and suggestions
+This project use issues to track public problems/suggestions. 
+Report a problem/suggestion by 
+[opening a new issue](https://github.com/yax-lakam-tuun/maya-decipherment/issues).
+It's that easy!
+The project distinguishes between `Bug` and `Suggestion`.
+
+A bug is some kind of infrastructure problem - not related to the content of the document.
+Infrastructure can cover LaTeX specifics or PowerShell problems, automatization or virtualization 
+issues to name a few.
+
+A suggestion addresses the content of the document directly.
+Please use this type to report mistakes, errors, but also improvements, additions etc.
+
+## Write issues for suggestions in detail, with background and sources
+A good report should include the following things:
+
+* A quick summary and/or background
+* Please refer to the chapter or TeX file you'd like to address.
+* Cite the section which should be changed.
+* Reason about the changes you'd like to see
+* Add a possible suggestion which might include:
+    * A rephrasing of the section. Maybe you can rewrite some parts to it fits into the document.
+    * A citation of a paper/book or any other available scientific source which can back up
+      the suggestion or which could be used to be cited in the document.
+    * Images or figures for illustration
+
+People *love* thorough reports. I'm not even kidding.
+Please use the `Suggestion` template for this kind of request when creating a new issue.
+
+## Consistent coding style
+The codebase has only a few rules with respect to coding styles.
+* Readability (of the source code) is the most important aspect
+* 4 spaces for indentation rather than tabs
+* 100 characters per line (exceptions permitted if readability would suffer, e.g. large tables)
+Please the chapter [LaTeX](documentation/latex.md) for more information.
+
+## In-depth documentation
+Everything documentation is located in the folder [documentation](documentation).
+
+## License
+By contributing, you agree that your contributions will be licensed under its 
+[MIT License](LICENSE).