Add guidelines for Copilot usage and commit messages
Updated dependencies and use Java 25.
This commit is contained in:
parent
7d16122e9e
commit
93de125e67
15
.github/JavaDoc-rules.md
vendored
Normal file
15
.github/JavaDoc-rules.md
vendored
Normal file
@ -0,0 +1,15 @@
|
||||
JavaDoc should be included for:
|
||||
[]: # - All public, protected and private classes and interfaces
|
||||
[]: # - All public, protected and private methods and constructors
|
||||
[]: # - Any method that overrides a superclass method
|
||||
[]: # 3. If JavaDoc is missing, please add it following these guidelines:
|
||||
[]: # - Use clear and concise language to describe the purpose and functionality.
|
||||
[]: # - Include descriptions for all parameters using @param tags.
|
||||
[]: # - Include a description of the return value using @return tags.
|
||||
[]: # - Mention any exceptions that the method might throw using @throws tags.
|
||||
[]: # - Follow standard JavaDoc formatting conventions.
|
||||
[]: # 4. After adding JavaDoc, review it for clarity and completeness.
|
||||
[]: # 5. Commit your changes with a message indicating that JavaDoc has been added or updated.
|
||||
[]: #
|
||||
[]: # By following these instructions, we can ensure that our codebase remains well-documented and easy to understand
|
||||
for all contributors.
|
||||
9
.github/copilot-instructions.md
vendored
Normal file
9
.github/copilot-instructions.md
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
When working on a prompt, please follow these instructions:
|
||||
|
||||
1. When creating Code then just create the code required to complete the task. Do not include any explanations,
|
||||
comments, or other text.
|
||||
2. After code changes, check if any JavaDoc is missing. Please see JavaDoc-rules.md for guidelines on adding JavaDoc.
|
||||
3. Create Unit Tests for the code you created or modified. Ensure that the tests cover various scenarios and edge cases.
|
||||
4. When writing commit messages, please follow the guidelines in git-commit-instructions.md to ensure clarity and
|
||||
consistency.
|
||||
5. Ensure that your code adheres to the project's coding standards and best practices.
|
||||
9
.github/git-commit-instructions.md
vendored
Normal file
9
.github/git-commit-instructions.md
vendored
Normal file
@ -0,0 +1,9 @@
|
||||
# Git Commit Message Guidelines
|
||||
|
||||
When creating a commit message, please follow these guidelines to ensure clarity and consistency across the project:
|
||||
|
||||
1. **Structure of Commit Message**:
|
||||
- The commit message should consist of a header, a body (optional), and a footer (optional).
|
||||
- The header should be a single line that summarizes the changes made.
|
||||
- If necessary, the body can provide additional context or details about the changes.
|
||||
- The footer can include references to issues or breaking changes.
|
||||
1
.github/prompts/TEST.prompt.md
vendored
Normal file
1
.github/prompts/TEST.prompt.md
vendored
Normal file
@ -0,0 +1 @@
|
||||
Please just respond with "Hello, World!"
|
||||
2
.mvn/wrapper/maven-wrapper.properties
vendored
2
.mvn/wrapper/maven-wrapper.properties
vendored
@ -14,5 +14,5 @@
|
||||
# KIND, either express or implied. See the License for the
|
||||
# specific language governing permissions and limitations
|
||||
# under the License.
|
||||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.8.6/apache-maven-3.8.6-bin.zip
|
||||
distributionUrl=https://repo.maven.apache.org/maven2/org/apache/maven/apache-maven/3.9.11/apache-maven-3.9.11-bin.zip
|
||||
wrapperUrl=https://repo.maven.apache.org/maven2/org/apache/maven/wrapper/maven-wrapper/3.2.0/maven-wrapper-3.2.0.jar
|
||||
|
||||
34
pom.xml
34
pom.xml
@ -22,38 +22,38 @@
|
||||
</modules>
|
||||
|
||||
<properties>
|
||||
<java.version>21</java.version>
|
||||
<java.version>25</java.version>
|
||||
<required.maven.version>3.8.6</required.maven.version>
|
||||
|
||||
<!-- Dependency versions -->
|
||||
<javafx.version>21.0.3</javafx.version>
|
||||
<javafx.version>25.0.1</javafx.version>
|
||||
<jetbrains.annotations.version>26.0.2</jetbrains.annotations.version>
|
||||
<junit.version>5.12.1</junit.version>
|
||||
<lombok.version>1.18.38</lombok.version>
|
||||
<mockito.version>5.16.1</mockito.version>
|
||||
<junit.version>6.0.1</junit.version>
|
||||
<lombok.version>1.18.42</lombok.version>
|
||||
<mockito.version>5.20.0</mockito.version>
|
||||
<reflections.version>0.10.2</reflections.version>
|
||||
<slf4j.version>2.0.17</slf4j.version>
|
||||
|
||||
<!-- Plugin dependencies -->
|
||||
<codehaus.version.plugin>2.16.2</codehaus.version.plugin>
|
||||
<codehaus.version.plugin>2.20.1</codehaus.version.plugin>
|
||||
<javafx.maven.plugin>0.0.8</javafx.maven.plugin>
|
||||
<jpackage.maven.plugin>0.1.5</jpackage.maven.plugin>
|
||||
<maven.clean.plugin>3.3.2</maven.clean.plugin>
|
||||
<maven.compiler.plugin>3.13.0</maven.compiler.plugin>
|
||||
<maven.clean.plugin>3.5.0</maven.clean.plugin>
|
||||
<maven.compiler.plugin>3.14.1</maven.compiler.plugin>
|
||||
<maven.dependency.plugin>3.6.1</maven.dependency.plugin>
|
||||
<maven.deploy.plugin>3.1.2</maven.deploy.plugin>
|
||||
<maven.deploy.plugin>3.1.4</maven.deploy.plugin>
|
||||
<maven.enforcer.plugin>3.4.1</maven.enforcer.plugin>
|
||||
<maven.install.plugin>3.1.2</maven.install.plugin>
|
||||
<maven.jar.plugin>3.4.1</maven.jar.plugin>
|
||||
<maven.javadoc.plugin>3.6.3</maven.javadoc.plugin>
|
||||
<maven.project.info.reports.plugin>3.5.0</maven.project.info.reports.plugin>
|
||||
<maven.resources.plugin>3.3.1</maven.resources.plugin>
|
||||
<maven.jar.plugin>3.5.0</maven.jar.plugin>
|
||||
<maven.javadoc.plugin>3.12.0</maven.javadoc.plugin>
|
||||
<maven.project.info.reports.plugin>3.9.0</maven.project.info.reports.plugin>
|
||||
<maven.resources.plugin>3.4.0</maven.resources.plugin>
|
||||
<maven.shade.plugin>3.5.3</maven.shade.plugin>
|
||||
<maven.site.plugin>4.0.0-M14</maven.site.plugin>
|
||||
<maven.surfire.plugin>3.2.5</maven.surfire.plugin>
|
||||
<maven.site.plugin>4.0.0-M16</maven.site.plugin>
|
||||
<maven.surfire.plugin>3.5.4</maven.surfire.plugin>
|
||||
<moditect.maven.plugin>1.0.0.RC2</moditect.maven.plugin>
|
||||
<maven.pmd.plugin>3.22.0</maven.pmd.plugin>
|
||||
<spotbugs.maven.plugin>4.8.5.0</spotbugs.maven.plugin>
|
||||
<maven.pmd.plugin>3.28.0</maven.pmd.plugin>
|
||||
<spotbugs.maven.plugin>4.9.8.2</spotbugs.maven.plugin>
|
||||
|
||||
<!-- other properties -->
|
||||
<pmd.target>pmd</pmd.target>
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user