[Tech] Initial code upload

Author: smiakchilo

.editorconfig

@@ -0,0 +1,26 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 4
+indent_style = space
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+ij_wrap_on_typing = false
+
+[*.java]
+ij_java_class_count_to_use_import_on_demand = 999
+ij_java_names_count_to_use_import_on_demand = 999
+ij_java_doc_add_blank_line_after_description = false
+ij_java_blank_lines_around_method = 1
+ij_java_blank_lines_around_method_in_interface = 1
+
+[*.js]
+ij_javascript_blank_lines_around_method = 0
+ij_javascript_blank_lines_around_class = 0
+ij_javascript_keep_simple_methods_in_one_line = true
+
+[*.json]
+indent_size = 2

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,84 @@
+# Maven
+target/
+pom.xml.tag
+pom.xml.releaseBackup
+pom.xml.versionsBackup
+pom.xml.next
+release.properties
+dependency-reduced-pom.xml
+buildNumber.properties
+.mvn/timing.properties
+
+# IntelliJ
+.idea/
+excluded/
+*.iml
+
+# Eclipse
+*.pydevproject
+.metadata
+.gradle
+bin/
+tmp/
+*.tmp
+*.bak
+*.swp
+*~.nib
+local.properties
+.settings/
+.loadpath
+
+# Eclipse Core
+.project
+
+# Locally stored "Eclipse launch configurations"
+*.launch
+
+# External tool builders
+.externalToolBuilders/
+
+# CDT-specific
+.cproject
+
+# Java
+*.class
+
+# Java annotation processor (APT)
+.factorypath
+
+# JDT-specific (Eclipse Java Development Tools)
+.classpath
+
+# PDT-specific
+.buildpath
+
+# sbteclipse plugin
+.target
+
+# TeXlipse plugin
+.texlipse
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files
+*.jar
+*.war
+*.ear
+*.zip
+
+# Virtual machine crash logs
+hs_err_pid*
+
+# Build reports
+
+it.tests/build
+
+# Supplementary folders
+graphics/
+
+# Vault
+.vlt
+
+# UI
+node_modules/

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,13 +1,13 @@
 # Contributor License Agreement
 
-Thank you for your interest in contributing to the **`PUT YOUR SOLUTION NAME`** (“Material”) by Exadel, Inc. ("We" or "Us"). The present Contributor License Agreement (“CLA”)  is for your protection as a Contributor as well as the protection of Us; it does not change your rights to use your own Contributions for any other purpose.  
+Thank you for your interest in contributing to the EToolbox AnyDiff ("Material") by Exadel, Inc. ("We" or "Us"). The present Contributor License Agreement ("CLA") is for your protection as a Contributor as well as the protection of Us; it does not change your rights to use your own Contributions for any other purpose.
 
 You must agree to the terms of this CLA before making a Contribution to the Material. This CLA covers any and all Contributions that You, now or in the future, submit to the Material. This CLA shall come into effect upon Your acceptance of its terms and conditions.
 
 ## 1. Definitions
-a. "You" means the individual Сopyright owner who Submits a Contribution to Us.
+a. "You" means the individual Copyright owner who Submits a Contribution to Us.
 
-b. "Contribution" means source code and any other copyrightable materials Submitted by you to Us, including any associated comments and documentation. 
+b. "Contribution" means source code and any other copyrightable materials submitted by you to Us, including any associated comments and documentation.
 
 c. "Copyright" means all rights protecting works of authorship, including copyright, moral and neighboring rights, as appropriate, for the full term of their existence.
 
@@ -48,6 +48,6 @@ To the maximum extent permitted by applicable law, in no event will You or We be
 
 You agree that this Material and Contributions to it are public and that a record of the Contribution (including all personal information you submit with it) is maintained indefinitely and may be redistributed consistent with this Material, compliance with the open source license(s) involved, and maintenance of authorship attribution.
 
-## 11. Miscellaneous
+## 10. Miscellaneous
 
 This CLA is the entire agreement between the parties and supersedes any and all prior agreements, understandings or communications, written or oral, between the parties relating to the subject matter hereof. You acknowledge that We are not obligated to use your Contribution as part of the Material distributed by Us and may make the decision to include any Contribution as We believe is appropriate.

.gitignore

@@ -1,44 +1,95 @@
-# Contributing to {{{SOLUTION_NAME}}}
-Contributions are welcomed and greatly appreciated. We want to make contributing to this project as easy and transparent as possible, whether it's:
-- Reporting a bug
-- Proposing new features
-- Discussing the current state of the code
-- Submitting a fix or solutions
-- Becoming a maintainer
+# Contributing to EToolbox AnyDiff
+Contributions to EToolbox AnyDiff are welcomed and greatly appreciated. We want to make contributing to this project as easy and transparent as possible, whether it is:
+- Reporting a bug;
+- Proposing new features;
+- Discussing the current state of the code;
+- Submitting a fix or solutions;
+- Becoming a maintainer.
 
 ## We develop with Github
-We use github to host code, to track issues and feature requests, as well as accept pull requests.
+We use Github to host code, track issues, accumulate feature requests, review and accept pull requests.
 
 ## We use Github Flow
 All code changes happen through Pull Requests.
 
-Pull requests are the best way to propose changes to the codebase (please follow this guid [Github Flow](https://guides.github.com/introduction/flow/index.html)).
+Pull requests are the best way to propose changes to the codebase (please follow this guide [Github Flow](https://guides.github.com/introduction/flow/index.html)).
 
 We actively welcome your pull requests:
-1. Fork the repo and create your branch from `master`.
-2. If you've added code that should be tested, add tests.
-3. If you've changed APIs, update the documentation.
-4. Ensure the test suite passes.
+1. Fork the repo and create your branch from `develop`.
+2. Do code changes. Whenever you create new files, add the "Licenced under the Apache Licence..." header (use any of the  existing files to copy the full header). Whenever you create new public or package-level methods, add Javadoc / JSDoc. Alter existing Javadoc / JSDoc if you change a method's signature.
+3. If you've added code that should be tested, add unit tests under the _test_ folder of the respective module. Make sure that the tests pass.
+4. If your code covers the features that cannot be verified without live connectivity to an AEM server or a 3rd party service, add an integration test under the _it.tests_ module. Make sure that the tests pass.
 5. Make sure your code lints.
-6. Issue that pull request!
+6. Issue the pull request.
 
-After creating your first contributing PR you will be requested to sign our Contributor License Agreement by commenting your PR with a special message.
+#### Procedural pull request questions
 
-## Any contributions you make will be under the {{{SOLUTION_LICENSE}}} License
-In short, when you submit code changes, your submissions are understood to be under the same {{{SOLUTION_LICENSE}}} that covers the project. Feel free to contact the maintainers if that's a concern.
+Every pull request is dedicated to a single Github issue. Every issue has a tracking number like `EAD-333`.
 
-## Report bugs using Github's [issues](https://github.com/{{{project}}}/issues)
-We use GitHub issues to track public bugs. 
-Report a bug by opening a new issue
+A branch for the pull request must be named in the format `bugfix/EAD-333` or `feature/EAD-333` where the part before the slash is the kind of PR (reflecting a bug or a feature request, respectively), and the part after the slash in the tracking number.
 
-## Write bug reports with detail
-[This is an template of bug report](https://github.com/exadel-inc/repository-template/blob/main/.github/ISSUE_TEMPLATE/bug_report.md)
+A pull request's title must start with the tracking number in square brackets; then comes a brief but detailed description of what is done in this PR like `[EAD-333] Fixed NPE when saving file to a removable media`.
 
-## Use a Consistent Coding Style
+A more verbose description in the "description" section is optional but welcomed. You can assign labels from the provided set, such as `bug`, `enhancement`, `documentation`, etc.
 
-* 2 spaces for indentation rather than tabs
-* You can try running `npm run lint` for style unification
-* Add code style files
+Every pull request consists of one or more commits. Commit messages must be presented in the same format as the pull request title. E.g., the following 3 commits: `[EAD-333] Implemented the NPE fix... [EAD-333] Altered Javadoc for the affected method... [EAD-333] Added a unit test for the NPE fix`.
 
-## Links to external documentation, mailing lists, or a code of conduct.
-## Community and behavioral expectations.
+## Licensing
+Any contributions you make are understood to be under the  [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0) that covers the whole project. Feel free to contact the maintainers if that's a concern.
+
+After creating your first pull request, you will be asked to sign our [Contributor License Agreement](../../Java/etoolbox-anydiff/CLA.md) by commenting on your PR with a special message.
+
+## Bug reporting
+We use Github's [issues](https://github.com/exadel-inc/etoolbox-authoring-kit/issues) to track public bugs.
+Report a bug by opening a new issue.
+
+#### Write bug reports with detail
+[This is an template of bug report](https://github.com/exadel-inc/repository-template/blob/main/.github/ISSUE_TEMPLATE/bug_report.md).
+
+## Use a Compliant and Consistent Coding Style
+
+#### For POM files
+
+* We place dependencies in the alphabetic order of their `groupId`-s except for the `uber-jar` that comes last to allow overlaying bundled dependencies.
+* Use `dependencyManagement` / `pluginManagement` sections of the main POM to specify the common requisites, scope, and config values of dependencies. Override them in a dependent POM file only if necessary.
+
+#### For Java code
+
+* We stick to the [Code Conventions for the Java Programming Language](https://www.oracle.com/java/technologies/javase/codeconventions-contents.html) and also to the [Google Java Style Guide](https://google.github.io/styleguide/javaguide.html) in essential parts.
+* We use 4 spaces for indentation rather than tabs.
+* Every import is a separate line, no wildcard imports.
+* Avoid static imports (like constants, etc.).
+* Give meaningful names to classes, methods, and variables.
+* Avoid long lines. No line should exceed 150 characters. Split lengthy lines where appropriate (between method arguments, before ternary operators, etc.).
+* Split lengthy methods into smaller parts. A method body must not exceed 20-25 lines.
+* Avoid introducing multi-line lambdas.
+* Observe the proper sequence of declarations: static variables (constants), then instance variables, then constructors, then instance methods, then static methods, then static nested classes.
+* Observe the proper sequence of visibility modifiers: public, then protected, then package-private, then private; public static, then package-private static, etc. You may place a private method immediately after the preceding public if called from this public as a secondary routine.
+* Avoid excessive visibility of classes or class member. E.g., do not make a class `public` if it is only called from other classes within this very package. In a public class, do not make a method `public` unless it will be called from a class residing in another package.
+* Declare methods that do not have a context (neither read nor mutate the instance fields of a class) as `static`.
+* Do not create methods with number of parameters greater than 4.
+* Use constants: no "magic" numbers and literals.
+* Add `try-catch` blocks to reduce the risk of code termination. Never ignore caught exceptions.
+* When unsure, follow the style of the existing code files.
+
+You can use the [.editorconfig file](https://github.com/exadel-inc/etoolbox-authoring-kit/blob/master/.editorconfig) to plug in you IDE.
+
+#### For JavaScript / CSS / LESS code
+
+* Use the predefined [eslint rules](https://github.com/exadel-inc/etoolbox-authoring-kit/blob/master/ui.apps/.eslintrc.json) to verify code with an IDE such as IntelliJ.
+* The rules are automatically applied via a Github workflow when you create or modify a pull request.
+* When unsure, follow the style of the existing code files.
+
+#### For XML markup files
+
+* Use proper indentation.
+* Split long lines into smaller ones by attributes.
+* When unsure, follow the style of the existing code files.
+
+## Community and behavioral expectations
+
+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 expect contributors, reviewers, and participants to express their opinions in a friendly, polite, and clear manner, raise and address issues in most precise, explaining and accurate sentences.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.