Add guidelines for Copilot usage and commit messages
Updated dependencies and use Java 25.
This commit is contained in:
@@ -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.
|
||||
@@ -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.
|
||||
@@ -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.
|
||||
@@ -0,0 +1 @@
|
||||
Please just respond with "Hello, World!"
|
||||
Reference in New Issue
Block a user