Ares: Add new ReadMe

[az108]

Checklist

General

• Language: I followed the guidelines for inclusive, diversity-sensitive, and appreciative language.
• I chose a title conforming to the naming conventions for pull requests.

Motivation and Context

The old documentation is outdated with the new features introduced in Ares2. Updated documentation allows instructors in Artemis to utilize Ares to its fullest potential.

Description

The old documentation has been updated to include new features such as Architecture, AspectJ, and Instrumentation tests.

Review Progress

Summary by CodeRabbit

• New Features
  • Updated the README to include new keywords and enhanced project description.
  • Introduced advanced security features with detailed examples for implementation.
• Documentation
  • Clarified minimum Java version requirement, now set to Java 21.
  • Improved readability and structure of the document.
  • Added new sections on security policies and testing practices.

[coderabbitai]

Walkthrough

The changes to the README.adoc file for the Ares project involve updates to the metadata, specifically the addition of new keywords and the removal of the previous author attribution. The minimum Java version requirement has been changed from 11 to 21, with corresponding updates throughout the document. New sections have been added to detail advanced security features and their implementation, while formatting adjustments have improved readability and structure.

Changes

File	Change Summary
README.adoc	- Updated metadata keywords: "architecture," "AspectJ," and "Instrumentation."
	- Cleared author attribution.
	- Changed minimum Java version requirement from 11 to 21.
	- Added methods with @Policy annotations for security policies in FileAccessTest, AspectJWriteBlockTest, and InstrumentationDeleteBlockTest.
	- Revised content for clarity on Ares functionality and advanced security features.
	- Made formatting adjustments for improved readability and structure.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Ares
    participant SecurityPolicy

    User->>Ares: Submit code
    Ares->>SecurityPolicy: Check submission against policies
    SecurityPolicy-->>Ares: Return validation result
    Ares-->>User: Notify submission status

Loading

🐇 "In the meadow where bunnies play,
Changes sprout like flowers in May.
With security strong and Java anew,
Ares shines bright, it's all true!
Policies set, the code will comply,
Hopping along, we reach for the sky!" 🌼

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

README.adoc (1)

Line range hint 264-480: Enhance readability of security features section.

The new section about advanced security features is comprehensive but could be improved:

1. Add language identifiers to YAML code blocks for syntax highlighting
2. Consider adding a table of contents entry specifically for security policies
3. Add cross-references to related sections

Apply this diff to improve the YAML code blocks:

-```yaml
+[source,yaml]
----
 regardingTheSupervisedCode:
   theFollowingProgrammingLanguageConfigurationIsUsed: JAVA_USING_MAVEN_ARCHUNIT_AND_ASPECTJ
   ...
-```
+----

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 973a371 and 4bd3966.

📒 Files selected for processing (1)

• README.adoc (9 hunks)

🔇 Additional comments (2)

README.adoc (2)

67-67: Verify Java version update impact.

The Java version requirement has been updated from 11 to 21, which is a significant change. Please ensure:

1. All Java version references in the documentation are consistently updated
2. The impact on existing users is clearly communicated
3. Consider adding a migration guide section for users upgrading from Java 11

Also applies to: 107-107, 113-114

---

3-4: Fix typo in keywords and verify author removal.

1. The keyword "Instrumentation" has a typo (should be lowercase "instrumentation").
2. The author field has been cleared. Please verify if this is intentional, as the license section still credits Christian Femers.