Add how to cite in README.md

mlco2 / codecarbon

Track emissions from Compute and recommend ways to reduce their impact on the environment.

https://mlco2.github.io/codecarbon

MIT License

1k stars 157 forks source link

Add how to cite in README.md #553

Closed benoit-cty closed 1 month ago

benoit-cty commented 1 month ago

Following https://github.com/mlco2/codecarbon/discussions/550

vict0rsch commented 1 month ago

I don't know why you think that I had something to do with this ommission @sashavor but yeah you should be there.

benoit-cty commented 1 month ago

Perfect! I just added my own name - it was missing for some reason 🙃

That's weird, but GitHub don't see any commit from your account : https://github.com/mlco2/codecarbon/graphs/contributors

But you certainly deserve to have your name in the list.

SaboniAmine commented 1 month ago

I'm sorry, but please next time avoid using commit messages to transmit this kind of information. We have efficient ways to solve communication issues, and a commit history is not one of them.

sashavor commented 1 month ago

I disagree, it's good to have transparency on these kinds of things, and digital traces of messages sent and received I've got nothing to hide!

On Sat, May 18, 2024, 12:06 Amine Saboni @.***> wrote:

I'm sorry, but please next time avoid using commit messages to transmit this kind of information. We have efficient ways to solve communication issues, and a commit history is not one of them.

— Reply to this email directly, view it on GitHub https://github.com/mlco2/codecarbon/pull/553#issuecomment-2118757226, or unsubscribe https://github.com/notifications/unsubscribe-auth/ADMMIIVO3CJUB34NVYV4QMLZC4R3DAVCNFSM6AAAAABH2J4FH6VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMJYG42TOMRSGY . You are receiving this because you were mentioned.Message ID: @.***>

SaboniAmine commented 1 month ago

You are right, and this thread seems, at least to me, the correct channel to have this discussion. It saves all context of this discussion, and the list of commits & file additions enables a meaningful history. And indeed, the absence of your name could be @vict0rsch's intention, or it could be not. As Benoît explained, the initial list of contributors have been automatically generated & didn't include you, for a mysterious reason, but it doesn't seem related to Victor. I was also mentioned twice, confirming the buggy generation. Oppositely, the history of messages in git have much less context, and is more prone to false interpretations. Here is what this message looks like in history, with few place to doubt. I would like to avoid this, and tend to more conventional commits