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

Acknowledging the whole group #199

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Acknowledging the whole group #199

wants to merge 1 commit into from

Conversation

ZachJHansen
Copy link
Collaborator

No description provided.

@ZachJHansen ZachJHansen requested a review from teiesti March 3, 2025 14:32
@@ -11,7 +11,7 @@ Check out the [API documentation](https://docs.rs/anthem/) for the available fun
## Where's anthem 1?

You're currently looking at version 2 of `anthem`, which is the latest version and the only one that is actively developed.
This is a complete reimplementation crafted by Zach Hansen and Tobias Stolzmann.
This is a complete reimplementation of the original system with significantly extended capabilities: we would like to thank everyone in the list of `contributors` for making it possible.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I wholeheartedly support the idea of acknowledging the whole group.

However, it was us to do the heavy lifting when it comes to implementation and I'd like to see this reflected in the credits. I'd also like to establish us as a contact persons in this regard. Furthermore, I'd like to distinguish our work from Patrick's work who is named personally in line 17.

You might object that we merely stand on the shoulder of giant who did all the theory for us but these people get credit as the authors of their respective papers.

That said, I'd like to suggest a compromise for the whole paragraph:

Until recently, you would have found Patrick Lühne's version 1 of `anthem` here, which was discontinued and therefore moved to [anthem-1](https://github.com/potassco/anthem-1).
You are currently looking at version 2, which is the latest version and the only one that is actively developed.
This version is a complete reimplementation of the original system with significantly extended capabilities.
It was started by Zach Hansen and Tobias Stolzmann, but is now being developed by a growing [group of people](CONTRIBUTORS.md).
We'd like to thank Patrick for the effort he put into his implementation and the kindness of resolving the naming conflict with us.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Documentation files like this usually have an ALL CAPS name like CONTRIBUTORS.md. Besides, we should stick to the Markdown syntax if this is a Markdown file.

@teiesti teiesti self-assigned this Mar 25, 2025
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