Refactoring (#275)

.devcontainer/devcontainer.json

@@ -1,5 +1,4 @@
-// For format details, see https://aka.ms/devcontainer.json. For config options, see the
-// README at: https://github.com/devcontainers/templates/tree/main/src/java
+// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at: https://github.com/devcontainers/templates/tree/main/src/java
 {
 	"name": "Java",
 	// Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile

.github/ISSUE_TEMPLATE/bug_report.md

@@ -12,9 +12,10 @@ A clear and concise description of what the bug is.
 
 **To Reproduce**
 Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+
+1. Go to '…'
+2. Click on '…'
+3. Scroll down to '…'
 4. See error
 
 **Expected behavior**
@@ -31,4 +32,4 @@ If applicable, add screenshots to help explain your problem.
 
 **Additional context**
 Add any other context about the problem here.
-Notably you can attach the file to stamp, if the problems comes from a file.
+Notably you can attach the file to stamp if the problems come from a file.

.github/dependabot.yml

@@ -1,5 +1,4 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
+# To get started with Dependabot version updates, you'll need to specify which package ecosystems to update and where the package manifests are located.
 # Please see the documentation for all configuration options:
 # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
 
@@ -8,4 +7,4 @@ updates:
   - package-ecosystem: "maven" # See documentation for possible values
     directory: "/" # Location of package manifests
     schedule:
-      interval: "weekly"
+      interval: "weekly"

.github/workflows/analyze.yml

@@ -45,6 +45,7 @@ jobs:
       - name: 'Qodana Scan'
         uses: JetBrains/qodana-action@v2023.3
         env:
+          args: --baseline,qodana.sarif.json
           QODANA_TOKEN: ${{ secrets.QODANA_TOKEN }}
 
       - uses: github/codeql-action/analyze@v3

.github/workflows/integrate-docx4j.yml

@@ -3,7 +3,7 @@
 # For more information see:
 #  https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 
-name: Continuous Integration for OS
+name: Continuous Integration for Docx4J
 
 on:
   workflow_dispatch:

.gitignore

@@ -1,7 +1,7 @@
 .idea
 *.iml
 settings.xml
-/target/
+**/target/
 /.classpath
 /.DS_Store
 /.project

CODE_OF_CONDUCT.md → CODE_OF_CONDUCT.adoc

@@ -1,6 +1,6 @@
-# Code of Conduct - Docx Stamper
+= Code of Conduct - Docx Stamper
 
-## Our Pledge
+== Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to make participation in our project and
@@ -9,31 +9,26 @@ size, disability, ethnicity, sex characteristics, gender identity and expression
 level of experience, education, socioeconomic status, nationality, personal
 appearance, race, religion, or sexual identity and orientation.
 
-## Our Standards
+== 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
+* 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 sexual language or imagery, and sexual attention or
-  advances
+* The use of sexual language or imagery, and sexual attention or advances
 * 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
-* Another 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
+* Another conduct which could reasonably be considered inappropriate in a professional setting
 
-## Our Responsibilities
+== Our Responsibilities
 
 Project maintainers are responsible for clarifying and enforcing our standards of
 acceptable behavior and will take appropriate and fair corrective action in
@@ -45,72 +40,71 @@ 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
+== 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
+== Enforcement
 
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at abuse@verron.pro.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at link:mailto:abuse@verron.pro[abuse@verron.pro].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of any incident
 reporter.
 
-## Enforcement Guidelines
+== 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
+=== 1. Correction
 
-**Community Impact**: Use of inappropriate language or other behavior deemed
+*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
+*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
+=== 2. Warning
 
-**Community Impact**: A violation through a single incident or series
+*Community Impact*: A violation through a single incident or series
 of actions.
 
-**Consequence**: A warning with consequences for continued behavior. No
+*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
+=== 3. Temporary Ban
 
-**Community Impact**: A serious violation of community standards, including
+*Community Impact*: A serious violation of community standards, including
 sustained inappropriate behavior.
 
-**Consequence**: A temporary ban from any sort of interaction or public
+*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
+=== 4. Permanent Ban
 
-**Community Impact**: Demonstrating a pattern of community
+*Community Impact*: Demonstrating a pattern of community
 standards violation, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes.
 
-**Consequence**: A permanent ban from any sort of public interaction within
+*Consequence*: A permanent ban from any sort of public interaction within
 the community.
 
-## Attribution
+== Attribution
 
-This Code of Conduct is adapted from the [Contributor Covenant](https://contributor-covenant.org/), version
-[1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md) and
-[2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md),
-and was generated by [contributing-gen](https://github.com/bttger/contributing-gen).
+This Code of Conduct is adapted from the https://contributor-covenant.org/[Contributor Covenant], version
+https://www.contributor-covenant.org/version/1/4/code-of-conduct/code_of_conduct.md[1.4] and
+https://www.contributor-covenant.org/version/2/0/code_of_conduct/code_of_conduct.md[2.0], and was generated by https://github.com/bttger/contributing-gen[contributing-gen].

CONTRIBUTING.adoc

@@ -0,0 +1,169 @@
+= Contributing to Docx Stamper
+
+First off, thanks for taking the time to contribute!
+❤️
+
+All types of contributions are encouraged and valued.
+See the <<Table of Contents>> for different ways to help and details about how this project handles them.
+Please make sure to read the relevant section before making your contribution.
+It will make it a lot easier for us maintainers and smooth out the experience for all involved.
+The community looks forward to your contributions.
+🎉
+
+____
+
+And if you like the project, but just don't have time to contribute, that's fine.
+There are other easy ways to support the project and show your appreciation, which we would also be thrilled about:
+- Star the project - Tweet about it - Refer to this project in your project's readme - Mention the project at local meetups and tell your friends/colleagues
+
+____
+
+== Table of Contents
+
+* <<Code of Conduct>>
+* <<I Have a Question>>
+* <<I Want To Contribute>>
+* <<Reporting Bugs>>
+* <<Suggesting Enhancements>>
+* <<Your First Code Contribution>>
+* <<Improving The Documentation>>
+* <<Styleguides>>
+* <<Commit Messages>>
+* <<Join The Project Team>>
+
+== Code of Conduct
+
+This project and everyone participating in it is governed by the
+https://github.com/verronpro/docx-stamperblob/master/CODE_OF_CONDUCT.md[Code of Conduct].
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to link:mailto:&#99;o&#110;&#x64;&#x75;&#x63;&#x74;&#64;&#x76;&#x65;r&#114;&#x6f;&#110;.&#112;&#114;&#111;[&#99;o&#110;&#x64;&#x75;&#x63;&#x74;&#64;&#x76;&#x65;r&#114;&#x6f;&#110;.&#112;&#114;&#111;]
+
+== I Have a Question
+
+____
+
+If you want to ask a question, we assume that you have read the available https://verronpro.github.io/docx-stamper/[Documentation].
+
+____
+
+Before you ask a question, it is best to search for existing https://github.com/verronpro/docx-stamper/issues[Issues] that might help you.
+In case you have found a suitable issue and still need clarification, you can write your question in this issue.
+It is also advisable to search the internet for answers first.
+
+If you then still feel the need to ask a question and need clarification, we recommend the following:
+
+* Open an https://github.com/verronpro/docx-stamper/issues/new[Issue].
+* Provide as much context as you can about what you're running into.
+* Provide project and platform versions (OS, Office version, docx4j version, etc), depending on what seems relevant.
+
+We will then take care of the issue as soon as possible.
+
+== I Want To Contribute
+
+'''
+
+=== Legal Notice
+
+When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
+
+'''
+
+=== Reporting Bugs
+
+==== Before Submitting a Bug Report
+
+A good bug report shouldn't leave others needing to chase you up for more information.
+Therefore, we ask you to investigate carefully, collect information and describe the issue in detail in your report.
+Please complete the following steps in advance to help us fix any potential bug as fast as possible.
+
+* Make sure that you are using the latest version.
+* Determine if your bug is really a bug and not an error on your side, e.g. using incompatible environment components/versions (Make sure that you have read the https://verronpro.github.io/docx-stamper/[documentation].
+If you are looking for support, you might want to check <<I Have a Question,this section>>).
+* To see if other users have experienced (and potentially already solved) the same issue you are having, check if there is not already a bug report existing for your bug or error in the https://github.com/verronpro/docx-stamperissues?q=label%3Abug[bug tracker].
+* Also make sure to search the internet (including Stack Overflow) to see if users outside the GitHub community have discussed the issue.
+* Collect information about the bug:
+* Stack trace (Traceback)
+* OS, Platform and Version (Windows, Linux, macOS, x86, ARM)
+* Version of the interpreter, compiler, SDK, runtime environment, package manager, depending on what seems relevant.
+* Possibly your input and the output
+* Can you reliably reproduce the issue?
+And can you also reproduce it with older versions?
+
+==== How Do I Submit a Good Bug Report?
+
+'''
+
+You must never report security related issues, vulnerabilities or bugs, including sensitive information to the issue tracker, or elsewhere in public.
+Instead, sensitive bugs must be sent by email to link:mailto:s&#101;c&#x75;&#114;&#x69;&#x74;&#121;&#64;v&#x65;&#x72;r&#111;&#x6e;&#x2e;&#112;&#114;&#111;[s&#101;c&#x75;&#114;&#x69;&#x74;&#121;&#64;v&#x65;&#x72;r&#111;&#x6e;&#x2e;&#112;&#114;&#111;].
+<!-- You may add a PGP key to allow the messages to be sent encrypted as well.
+-->
+
+'''
+
+We use GitHub issues to track bugs and errors.
+If you run into an issue with the project:
+
+* Open an https://github.com/verronpro/docx-stamper/issues/new[Issue].
+(Since we can't be sure at this point whether it is a bug or not, we ask you not to talk about a bug yet and not to label the issue.)
+* Explain the behavior you would expect and the actual behavior.
+* Please provide as much context as possible and describe the _reproduction steps_ that someone else can follow to recreate the issue on their own.
+This usually includes your code.
+For good bug reports, you should isolate the problem and create a reduced test case.
+* Provide the information you collected in the previous section.
+
+Once it's filed:
+
+* The project team will label the issue accordingly.
+* A team member will try to reproduce the issue with your provided steps.
+If there are no reproduction steps or no obvious way to reproduce the issue, the team will ask you for those steps and mark the issue as `needs-repro`.
+Bugs with the `needs-repro` tag will not be addressed until they are reproduced.
+* If the team is able to reproduce the issue, it will be marked `needs-fix`, as well as possibly other tags (such as `critical`), and the issue will be left to be <<Your First Code Contribution,implemented by someone>>.
+
+=== Suggesting Enhancements
+
+This section guides you through submitting an enhancement suggestion for Docx Stamper, *including completely new features and minor improvements to existing functionality*.
+Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
+
+==== Before Submitting an Enhancement
+
+* Make sure that you are using the latest version.
+* Read the https://verronpro.github.io/docx-stamper/[documentation] carefully and find out if the functionality is already covered, maybe by an individual configuration.
+* Perform a https://github.com/verronpro/docx-stamper/issues[search] to see if the enhancement has already been suggested.
+If it has, add a comment to the existing issue instead of opening a new one.
+* Find out whether your idea fits with the scope and aims of the project.
+It's up to you to make a strong case to convince the project's developers of this feature merits.
+Keep in mind that we want features that will be useful to the majority of our users and not just a small subset.
+If you're just targeting a minority of users, consider writing an add-on/plugin library.
+
+==== How Do I Submit a Good Enhancement Suggestion?
+
+Enhancement suggestions are tracked as https://github.com/verronpro/docx-stamper/issues[GitHub issues].
+
+* Use a *clear and descriptive title* for the issue to identify the suggestion.
+* Provide a *step-by-step description of the suggested enhancement* in as many details as possible.
+* *Describe the current behavior* and *explain which behavior you expected to see instead* and why.
+At this point you can also tell which alternatives do not work for you.
+* You may want to *include screenshots and animated GIFs* which help you demonstrate the steps or point out the part which the suggestion is related to.
+You can use https://www.cockos.com/licecap/[this tool] to record GIFs on macOS and Windows, and https://github.com/colinkeenan/silentcast[this tool] or https://github.com/GNOME/byzanz[this tool] on Linux. <!-- this should only be included if the project has a GUI -->
+* *Explain why this enhancement would be useful* to most Docx Stamper users.
+You may also want to point out the other projects that solved it better and which could serve as inspiration.
+
+=== Your First Code Contribution
+
+=== Improving The Documentation
+
+TODO
+
+== Styleguides
+
+=== Commit Messages
+
+TODO
+
+== Join The Project Team
+
+TODO
+
+== Attribution
+
+This guide is based on the *contributing-gen*. https://github.com/bttger/contributing-gen[Make your own]!