#2: Add project skeleton (#3)

* #2: Add project skeleton with required file and directory structure
---------

Co-authored-by: kaklakariada <kaklakariada@users.noreply.github.com>

Author: redcatbear

.github/ISSUE_TEMPLATE/Bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug report
+about: Create a report to help us improve
+
+---
+
+# Description
+A clear and concise description of what the bug is.
+
+## Steps to Reproduce
+1. ...
+2. ...
+
+## Expected behavior
+A clear and concise description of what you expected to happen.
+
+# Environment
+- OFT: [e.g. 1.2.3]
+- AsciiDoc plugin: [e.g. 1.0.1]
+- OS: [e.g. Debian Linux 9, Kernel 4.13.0]
+- Java Version: [e.g. openjdk version "1.8.0_162"]
+- Maven Version (in case of build problems only): [e.g. 3.5.0]
+
+## Additional context
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/Custom.md

@@ -0,0 +1,9 @@
+---
+name: User Story
+about: A use scenario written from the perspective of the end user
+
+---
+
+As a *role name*
+I want to ...
+in order to ...

.github/ISSUE_TEMPLATE/Feature_request.md

@@ -0,0 +1,17 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"

.github/workflows/github_release.sh

@@ -6,15 +6,15 @@ set -o pipefail
 
 base_dir="$( cd "$(dirname "$0")/../.." >/dev/null 2>&1 ; pwd -P )"
 readonly base_dir
-readonly pom_file="$base_dir/parent/pom.xml"
+readonly pom_file="$base_dir/pom.xml"
 
 # Read project version from pom file
-project_version=$(grep "<revision>" "$pom_file" | sed --regexp-extended 's/\s*<revision>(.*)<\/revision>\s*/\1/g')
+project_version=$(grep "<version>" "$pom_file" | sed --regexp-extended 's/\s*<version>(.*)<\/version>\s*/\1/g' | head --lines=1)
 readonly project_version
 echo "Read project version '$project_version' from $pom_file"
 
 # Calculate checksum
-readonly artifact_path="$base_dir/product/target/openfasttrace-${project_version}.jar"
+readonly artifact_path="$base_dir/target/openfasttrace-asciidoc-plugin-${project_version}.jar"
 echo "Calculate sha256sum for file '$artifact_path'"
 file_dir="$(dirname "$artifact_path")"
 readonly file_dir
@@ -26,12 +26,8 @@ sha256sum "$file_name" > "$checksum_file_name"
 readonly checksum_file_path="$file_dir/$checksum_file_name"
 cd "$base_dir"
 
-
 # Create GitHub release
 readonly changes_file="$base_dir/doc/changes/changes_${project_version}.md"
-notes=$(cat "$changes_file")
-readonly notes
-
 readonly title="Release $project_version"
 readonly tag="$project_version"
 echo "Creating release:"
@@ -41,6 +37,6 @@ echo "Changes file : $changes_file"
 echo "Artifact file: $artifact_path"
 echo "Checksum file: $checksum_file_path"
 
-release_url=$(gh release create --latest --title "$title" --notes "$notes" --target main "$tag" "$artifact_path" "$checksum_file_path")
+release_url=$(gh release create --latest --title "$title" --notes-file "$changes_file" --target main "$tag" "$artifact_path" "$checksum_file_path")
 readonly release_url
 echo "Release URL: $release_url"

.idea/.gitignore

@@ -0,0 +1,39 @@
+Thank you for your interest in helping us to make OpenFastTrace (OFT) better!
+
+# Goal of This Document
+This document aims at answering all the questions potential contributors to OFT might have before feeling ready to get started.
+
+# What This Document is not
+If you are looking for general information about what OpenFastTrace is, please make sure to check out the [ReadMe](./README.md) that comes with the project.
+
+# What Kind of Contributions can I Make?
+
+## Contributing Code
+If you are a programmer and want to help us improve the implementation, test cases or design of OFT please create a branch of the current `main` branch of OFT using [git](https://git-scm.com/) and make your changes on that branch.
+
+Then please create a pull request and ask for a review by one of the core team members (e.g. `redcatbear` or `kaklakariada`).
+The reviewers will either ask you to work in review findings or if there are none, merge your branch.
+
+## Testing
+We are happy if you test OFT! While we do a great deal of testing ourselves, we want OFT to be as portable as possible. So it is especially helpful for us if you test on a platform that we don't have.
+
+If you find a bug, please let us know by writing an [issue ticket](https://github.com/itsallcode/openfasttrace/issues/new?template=Bug_report.md). There is a template for bug tickets that helps you provide all the information that we need to reproduce and tackle the bug you found.
+
+If you are a programmer, a code contribution in form of an automatic unit test case would be most appreciated, since this will make reproduction of the issue easier and prevent future regressions.
+
+## Contributing to the User Guide
+Maybe you are good at explaining how to use OFT to end users? Help us improve the [user guide](doc/user_guide.md)!
+
+## Translations
+We plan to make OFT multilingual. If you want to provide a translation, feel free to contact us. Messages in OFT and the user guide are prime candidates for translation.
+
+## Fields of Application
+Found a clever way to apply OFT in a new field of application? [Share your story with the OFT community](https://github.com/itsallcode/openfasttrace/wiki/OFT-Stories)!
+
+## Ideas
+Last but not least if you have ideas for ways to improve or extend OFT, feel free to write a [feature request](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/issues/new?template=Feature_request.md).
+
+# Style Guides
+We want OFT to have a professional and uniform coding style. Formatter rules for Eclipse are part of the project. If you use a different editor, please make sure to match the current code formatting.
+
+We develop the code following the principles described in Robert C. Martin's book "Clean Code" as our guide line for designing and organizing the code.

CONTRIBUTING.md

@@ -1,2 +1,91 @@
-# openfasttrace-asciidoc-plugin
-AsciiDoc-importer for OpenFastTrace
+# <img src="doc/openfasttrace_logo.svg" alt="OFT logo" width="150"/> OpenFastTrace AsciiDoc Plugin
+
+## What is OpenFastTrace AsciiDoc Plugin?
+
+This plugin allows OpenFastTrace (OFT) to parse and trace requirements in AsciiDoc files. Requirement tracing keeps track of whether you implemented everything you planned to in your specifications. It also identifies obsolete parts of your product and helps you to get rid of them.
+
+For more details about requirement tracing and how to use OpenFastTrace, refer to the [user guide](doc/user_guide.md).
+
+_[Place a screenshot of a tracing report generated using this plugin here]_
+
+## Project Information
+
+[![Build](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/actions/workflows/build.yml/badge.svg)](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/actions/workflows/build.yml)
+
+Sonarcloud status:
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=bugs)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=coverage)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=org.itsallcode%3Aopenfasttrace-asciidoc-plugin&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=org.itsallcode%3Aopenfasttrace-asciidoc-plugin)
+
+## What is AsciiDoc?
+
+[AsciiDoc](https://asciidoc.org/) is a human-readable document format, semantically equivalent to DocBook XML, but using plain-text mark-up conventions. AsciiDoc documents can be created using any text editor and can be viewed and edited in source form without requiring additional tools.
+
+AsciiDoc is highly configurable: both the AsciiDoc source file syntax and the backend output markups (which can be almost any type of SGML/XML markup) can be customized and extended by the user.
+
+## How does AsciiDoc fit into OFT?
+
+In the context of OpenFastTrace (OFT), AsciiDoc files can be used to write the software requirements specification. The AsciiDoc format allows for requirement IDs to be embedded in the text, which can then be traced by OFT.
+
+Using the AsciiDoc Plugin, OFT is able to read and parse AsciiDoc files, trace the requirements mentioned in the files, and generate a requirement tracing report. This allows for easy tracking of the implementation status of each requirement directly from the specification document.
+
+**User Guides**
+
+* [📖 User Guide](doc/user_guide.md)
+
+**News and Discussions**
+
+* [📢 Blog](https://blog.itsallcode.org/)
+* [🗨️ Discussion Board](https://github.com/itsallcode/openfasttrace/discussions)
+
+**Information for Contributors**
+
+* [🎟️ Project Board](https://github.com/orgs/itsallcode/projects/3/views/1)
+* [🦮 Developer Guide](doc/developer_guide.md)
+* [🎁 Contributing Guide](CONTRIBUTING.md)
+
+## Using OpenFastTrace AsciiDoc Plugin
+
+The plugin can be used with the standard OFT command line, integrated into Maven or Gradle build cycles, or applied through a continuous integration pipeline.
+
+For more detailed information on how to use OpenFastTrack with AsciiDoc Plugin, consult our [user guide](doc/user_guide.md).
+
+## Getting OpenFastTrace AsciiDoc Plugin
+
+The OpenFastTrace AsciiDoc Plugin is supplied as a Java Archive (JAR) which can be obtained from:
+
+* [Maven Central](#)
+* [GitHub](https://github.com/itsallcode/openfasttrace-asciidoc-plugin/releases)
+
+More details about adding the plugin to an existing establishment are outlined in the [developer guide](doc/developer_guide.md).
+
+## Installation
+
+### Runtime Dependencies
+
+OpenFastTrace AsciiDoc Plugin needs a Java 17 (or later) runtime environment to run properly.
+
+#### Installation of Runtime Dependencies on Linux
+
+##### Ubuntu or Debian
+
+To install Java Runtime Environment:
+
+    apt-get install openjdk-17-jre
+
+## Running OpenFastTrace With the AsciiDoc Plugin
+
+To run OFT with the plugin, you can add the plugin to the Java classpath or one of OFT's plugin search directories.
+
+For more details, please check out the OFT user guide's chapter on plugins.
+
+<!-- TODO: add link -->

README.md

@@ -0,0 +1,3 @@
+# Changes
+
+* [0.1.0](changes_0.1.0.md)

doc/changes/changelog.md

@@ -0,0 +1,27 @@
+# OpenFastTrace AsciiDoc Plugin 0.1.0, released YYYY-MM-DD
+
+Code name: {Codename}
+
+## Summary
+
+In this inaugural release of the AsciiDoc OpenFastTrace Plugin, we have established a foundation for adding, updating, and manipulating OpenFastTrace specification items directly within AsciiDoc documents.
+
+Here you can add more details about the general changes and improvements of this version.
+
+## Breaking Changes
+
+If there were significant or breaking changes made in this version, describe them here.
+
+## Features
+
+* If there were any major features added in this version, list them here. Each feature should contain a brief explanation and, if applicable, any issue or PR numbers related to the feature.
+
+## Bug Fixes
+
+* If there were any bugs fixed in this version, detail them here. Like the features, they should contain a concise explanation and relevant issue numbers.
+
+## Known Issues
+
+* If there are any known issues in this version that were not fixed, list them here. Provide as much detail as possible to help users understand the impact and any potential workarounds.
+
+Please replace 'YYYY-MM-DD' with the actual release date, and '{Codename}' with the actual codename for this version, if any.