Skip to content

Improving the "contributor's guide" and simplifying the benchmark's schema#21

Merged
xuafeng merged 14 commits intosys-intelligence:mainfrom
bastoica:main
Dec 1, 2025
Merged

Improving the "contributor's guide" and simplifying the benchmark's schema#21
xuafeng merged 14 commits intosys-intelligence:mainfrom
bastoica:main

Conversation

@bastoica
Copy link
Collaborator

Description

This PR improves the step-by-step "contributor's guide" by simplifying the text, explaining what to change, enhance and how to add a new artifact (with code snippets), as well as simplifying the benchmark's schema.

Changes

  • A simplified README.md with more details about what to modify and extend when adding a new artifact to ArtEvalBench
  • A new WHY.md which contains general background about the artifact evaluation (AE) process
  • A more descriptive benchmark schema

Testing

Tested locally on a single artifact.

Checklist

  • Tests pass locally
  • Code follows project style guidelines
  • Documentation updated (if needed)

@bastoica bastoica requested a review from xuafeng November 20, 2025 21:31
@bastoica bastoica self-assigned this Nov 20, 2025
@bastoica bastoica added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 20, 2025
@bastoica bastoica marked this pull request as ready for review November 20, 2025 21:32
@xuafeng xuafeng requested a review from tareknaser November 20, 2025 22:18
Copy link
Collaborator

@tareknaser tareknaser left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the nice work! I just have a few minor comments and nitpicks

@bastoica bastoica marked this pull request as draft November 25, 2025 03:40
Copy link
Collaborator

@xuafeng xuafeng left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The changes look good, especially the WHY.md part. Let me merge it.

@xuafeng xuafeng requested review from tareknaser and removed request for tareknaser December 1, 2025 18:08
@bastoica bastoica marked this pull request as ready for review December 1, 2025 18:24
@xuafeng xuafeng merged commit 13c5fa1 into sys-intelligence:main Dec 1, 2025
2 checks passed
@bastoica bastoica mentioned this pull request Dec 6, 2025
Couen pushed a commit to Couen/system-intelligence-benchmark that referenced this pull request Jan 22, 2026
Improving the "contributor's guide" and simplifying the benchmark's schema
tareknaser pushed a commit that referenced this pull request Feb 5, 2026
Improving the "contributor's guide" and simplifying the benchmark's schema
Couen pushed a commit to Couen/system-intelligence-benchmark that referenced this pull request Feb 25, 2026
Improving the "contributor's guide" and simplifying the benchmark's schema
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add a simpler artifact to ArtEvalBench as an example Improve the step-by-step guidelines vor ArtEvalBench by showing a walkthrough example

3 participants