[refactor] Rebrand eXist-db to Elemental

Author: adamretter

.github/ISSUE_TEMPLATE.md

@@ -5,21 +5,20 @@ To be able to better understand you problem or suggestion, please add as much in
 Please fill in the following sections:
 
 ### What is the problem
-> Describe exactly what you see (e.g. an output of an XQuery) 
+> Describe exactly what you see (e.g. the output of an XQuery) 
 
 ### What did you expect
-> Describe what you expected to happen. Add for example a reference to a [specification](https://www.w3.org/TR/xquery-3/).
+> Describe what you expected to happen. Add for example a reference to a [specification](https://www.w3.org/TR/xquery-31/).
 
 ### Describe how to reproduce or add a test
-> Describe how we can can reproduce the problem.
+> Describe how we can reproduce the problem.
 
-> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) (XQuery - Run as Test)
+> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via `XQuery` > `Run as Test`.
 
 ### Context information
-Please always add the following information
-- eXist-db version + Git Revision hash e.g. eXist-db 3.0 /  acd0c14 
-- Java version (e.g. Java8u121)
-- Operating system (Windows 7, Linux, MacOs)
-- 32 or 64 bit
-- How is eXist-db installed? (JAR installer, DMG, .tar.gz/.zip distribution, clone from GitHub)
-- Any custom changes in e.g. conf.xml
+Please always add the following information:
+- Elemental version + Git Revision hash e.g. Elemental 6.3.1 / 31fc2c1 
+- Java version (e.g. Java 8u121)
+- Operating system (Windows 11, Linux, macOS)
+- How is Elemental installed? (JAR installer, DMG, .tar.gz/.zip distribution, clone from GitHub)
+- Any custom config changes in e.g. conf.xml

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,13 +1,13 @@
 ---
 name: Bug report
-about: Thank you for reporting your issue and helping us to improve!
+about: Thank you for helping us to improve Elemental by reporting a bug.
 title: "[BUG]"
 labels: ''
 assignees: ''
 
 ---
 
-> To be able to better understand you problem, please add as much information as possible to this ticket. Always test your bugs against the latest stable release of exist. We cannot provide support for older versions here on GitHub. If the version of eXist that is experiencing the issue is more than 1 major version behind the most recent release, please consider posting a question on our mailing list. 
+> To be able to better understand you problem, please add as much information as possible to this ticket. Please also test your bugs against the latest stable release of Elemental to check whether it has already been fixed.
 
 
 **Describe the bug**
@@ -17,29 +17,30 @@ A clear and concise description of what the bug is.
 A clear and concise description of what you expected to happen.
 
 **To Reproduce**
-> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) (XQuery - Run as Test)
+> The *best* way is to provide an [SSCCE (Short, Self Contained, Correct (Compilable), Example)](http://sscce.org/). One type of SSCCE could be a small test which reproduces the issue and can be run without dependencies. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) `XQuery` > `Run as Test`.
 
-```Xquery
+```xquery
 xquery version "3.1";
 
 module namespace t="http://exist-db.org/xquery/test";
 
 declare namespace test="http://exist-db.org/xquery/xqsuite";
 
-<!--  replace root with your data -->
+(: Replace root with your data :)
 declare variable $t:XML := document {
-<root/>
+    <root/>
 };
 
-<!--  replace index config if needed -->
-declare variable $t:xconf :=
+(: Replace index config if needed :)
+declare variable $t:xconf := document {
     <collection xmlns="http://exist-db.org/collection-config/1.0">
-    <index xmlns:xs="http://www.w3.org/2001/XMLSchema">
-        <fulltext default="none" attributes="false"/>
-    </index>
-</collection>;
+        <index xmlns:xs="http://www.w3.org/2001/XMLSchema">
+            <fulltext default="none" attributes="false"/>
+        </index>
+    </collection>
+};
 
-<!--  collections and indexes can be configured here  -->
+(: Collections and Indexes can be configured here :)
 declare
     %test:setUp
 function t:setup() {
@@ -60,33 +61,33 @@ function t:tearDown() {
     xmldb:remove("/db/system/config/db/test")
 };
 
-<-- Adjust to your reported issue -->
+(: Adjust to your reported issue :)
 declare
-    %test:assertTrue
-function t:test() {
+    %test:assertEquals(1)
+function t:test-1() {
     let $test-data := collection('/db/test')
     for $result in $test-data//root
     return
-       count($result) eq 1
+       count($result)
 };
 ```
 
-If the above isn't working, please tell us the exact steps you took when you encountered the problem:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+If the above isn't working, please tell us the exact steps you took when you encountered the problem, e.g.
+1. Go to ...
+2. Click on ...
+3. Scroll down to ...
+4. Results in the error ...
 
 **Screenshots**
 If applicable, add screenshots to help explain your problem.
 
 **Context (please always complete the following information)**
-One option is to use [xst](https://www.npmjs.com/package/@existdb/xst), and copy and paste the output produced by running `xst info` here:**
 
- - Build: [eXist-6.1.0]
- - Java: [1.8.0_352]
- - OS: [Mac OS X 12.6.2]
+* Version: [Elemental 6.3.1]
+* Java: [1.8.0_352]
+* OS: [macOS X 12.6.2]
 
 **Additional context**
-- How is eXist-db installed? [e.g. JAR installer, DMG, … ]
-- Any custom changes in e.g. `conf.xml`?
+
+* How is Elemental installed? [e.g. JAR installer, DMG, … ]
+* Any custom changes in e.g. `conf.xml`?

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,19 +1,19 @@
-Thank you for your contribution to eXist-db! 
+Thank you for contributing to Elemental! 
 
-To help the community judge your pull request (PR), please include the following:
+To help the community judge your PR (Pull Request), please include the following:
 
-- A (short) description of the content of changes.
-- A context reference to a [Github Issue](https://github.com/evolvedbinary/elemental/issues), a message in the [eXist-open mailinglist](http://exist-open.markmail.org), or a [specification](https://www.w3.org/TR/xquery-31/).
-- Tests. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it very easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via XQuery > Run as Test.
+- A (short) description of the content of your changes.
+- A context reference to a [Github Issue](https://github.com/evolvedbinary/elemental/issues), a message in the [Elemental users mailing list](https://groups.google.com/u/1/a/elemental.xyz/g/users), or a [specification](https://www.w3.org/TR/xquery-31/).
+- Tests. The [XQSuite - Annotation-based Test Framework for XQuery](http://exist-db.org/exist/apps/doc/xqsuite.xml) makes it easy for you to create tests. These tests can be executed from the [eXide editor](http://exist-db.org/exist/apps/eXide/index.html) via `XQuery` > `Run as Test`.
 
-Your PR will be tested using [GitHub Actions](https://github.com/evolvedbinary/elemental/actions) against a number of operating systems and environments. The build status is visible in the PR. 
+Your PR will be tested using [CircleCI](https://github.com/evolvedbinary/elemental/actions) against a number of operating systems and environments. The build status is visible in the PR. 
 
-To detect errors in your PR before submitting it, please run eXist's full test suite on your own system via `mvn -V clean verify`.
+To detect errors in your PR before submitting it, please run Elemental's full test suite on your own system via `mvn -V clean site`.
 
 ------
 
 ### Description:
 
 ### Reference:
 
-### Type of tests:
+### Tests:

.github/opencollective.yml

@@ -1,11 +1,11 @@
-# Building eXist-db from Source
+# Building Elemental from Source Code
 
-eXist-db itself is written in Java 8. The build system is [Apache Maven](http://maven.apache.org/). If you're not familiar with Git, we recommend [this excellent online interactive tutorial](http://try.github.io).
+Elemental itself is written in Java 8. The build system is [Apache Maven](http://maven.apache.org/). If you're not familiar with Git, we recommend [this excellent online interactive tutorial](http://try.github.io).
 
-To build eXist-db:
+To build Elemental:
 
 - Checkout the Git Repository
-- Execute a Maven to compile eXist-db
+- Execute a Maven to compile Elemental
 
 ```bash
 $ git clone https://github.com/evolvedbinary/elemental.git
@@ -14,14 +14,14 @@ $ git checkout gold
 $ mvn -DskipTests package
 ```
 
-From here, you now have a compiled version of eXist-db in the `exist-distribution/target` folder that you may use just as you would an installed version of eXist-db. An installer is also build and present uin `exist-installer/target` for easy installation elsewhere.
+From here, you now have a compiled version of Elemental in the `exist-distribution/target` folder that you may use just as you would an installed version of Elemental. An installer is also build and present in `exist-installer/target` for easy installation elsewhere.
 
 Useful build switches:
 - `-Ddocker=true` : builds the docker image
 - `-DskipTests` : skips running tests
 - `-Ddependency-check.skip=true` : skips validating dependencies
 
-Further build options can be found at: [eXist-db Build Documentation](http://www.exist-db.org/exist/apps/doc/exist-building.xml "How to build eXist").
+Further build options can be found at: [eXist-db Build Documentation](http://www.exist-db.org/exist/apps/doc/exist-building.xml "How to build eXist-db").
 
 **NOTE:** 
 In the above example, we switched the current (checked-out) branch from `main` to `gold`.

BUILD.md

@@ -2,76 +2,68 @@
 
 ## 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, sex characteristics, gender identity and expression,
-level of experience, education, socio-economic status, nationality, personal
-appearance, race, religion, or sexual identity and orientation.
+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, caste, color, 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 creating a positive environment
-include:
+Examples of behavior that contributes to a positive environment for our community 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
+* 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 by participants include:
+Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
+* 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 electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* 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
 
-## Our Responsibilities
+## Enforcement 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.
+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.
 
-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.
+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 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.
+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 email 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 by contacting the project team at [email protected]. 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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at [email protected]. All complaints will be reviewed and investigated promptly and fairly.
 
-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.
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
 
-## Attribution
+## 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.
 
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+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
 
-[homepage]: https://www.contributor-covenant.org
+This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1, available at https://www.contributor-covenant.org/version/2/1/code_of_conduct.html.
 
-For answers to common questions about this code of conduct, see
-https://www.contributor-covenant.org/faq
+Community Impact Guidelines were inspired by [Mozilla’s code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
+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.