konrad/NeitzelLib
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add guidelines for Copilot usage and commit messages

Browse Source 
Updated dependencies and use Java 25.
This commit is contained in:
Konrad Neitzel
2025-11-29 22:47:48 +01:00
parent 7d16122e9e
commit 93de125e67
6 changed files with 52 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/JavaDoc-rules.md
+15
View 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.