Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add fix quality metadata to ChangeSet spec #47

Merged
merged 4 commits into from
Feb 19, 2025
Merged

Conversation

drdavella
Copy link
Member

No description provided.

@drdavella drdavella requested a review from nahsra February 18, 2025 21:06
@drdavella
Copy link
Member Author

After further discussion we might be looking for three separate ratings:

  1. Safety (can I take this change without breaking my code)
  2. Effectiveness (does it fix the problem without introducing syntactic or semantic changes)
  3. Cleanliness (does this code introduce stylistic issues, add/remove comments, etc.)

It's worth noting that these are not strictly independent categories so we need to be careful when scoring.

From a user perspective, I might argue that they really only care about two dimensions:

  1. Is the fix correct?
  2. Will it break my app?

However, those two could ultimately be derived from the first three criteria.

@nahsra
Copy link
Contributor

nahsra commented Feb 19, 2025

From a user perspective, I might argue that they really only care about two dimensions:
Is the fix correct?
Will it break my app?

I'd argue these are just different ways of "safe" and "effective".

Copy link
Contributor

@nahsra nahsra left a comment

Choose a reason for hiding this comment

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

Are the 3 things implementation details of the 1 thing? I'm developing more conviction about:

  • Safe
  • Effective
  • Palatability

I think "safe" encapsulates a whole set of concerns about off-target effects on the code compilation and code functioning.

I think "effective" encapsulates everything about the fix effectiveness, completeness, durability, etc.

I think "palatability" is about all the stylistic / formatting / bikeshedding / team norm kind of stuff that we will, frankly, only have limited insight into. If we're going to be opinionated about how implementors should feel about this change by exposing these, we must come to agreement about the factors now, and I'm happy to do that.

@nahsra
Copy link
Contributor

nahsra commented Feb 19, 2025

Shouldn't this also be at the "change" level, rather than the changeset? I might be misunderstanding, but each individual change will have its own score, right? Or are we asking CodeTF providers to estimate a "global score"?

@drdavella
Copy link
Member Author

Shouldn't this also be at the "change" level, rather than the changeset? I might be misunderstanding, but each individual change will have its own score, right? Or are we asking CodeTF providers to estimate a "global score"?

My assumption so far has been that this evaluation applies per fix and we have effectively been assuming a 1:1 mapping between fixed finding and changeset entry.

@drdavella drdavella requested a review from nahsra February 19, 2025 15:09
@drdavella drdavella merged commit dcc92ae into main Feb 19, 2025
2 checks passed
@drdavella drdavella deleted the fix-quality-ratings branch February 19, 2025 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants