Skip to content

Switch to AUTHORS.md #1901

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

Merged
merged 4 commits into from
Jun 6, 2025
Merged

Switch to AUTHORS.md #1901

merged 4 commits into from
Jun 6, 2025

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Jun 3, 2025

Changes proposed in this pull request

Use AUTHORS.md rather than AUTHORS. Also, switch to list, add links to GitHub handles, and typeset names in bold font.

See also: Cantera/cantera-website#272

PS: I also added an unrelated fix:

Fixes #1871.

If applicable, provide an example illustrating new features this pull request is introducing

For a rendered version, see https://github.com/ischoegl/cantera/blob/rename-authors-file/AUTHORS.md

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 74.10%. Comparing base (5bbf58b) to head (b7328d0).
Report is 42 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1901      +/-   ##
==========================================
- Coverage   74.11%   74.10%   -0.02%     
==========================================
  Files         444      444              
  Lines       55556    55516      -40     
  Branches     9132     9128       -4     
==========================================
- Hits        41177    41140      -37     
+ Misses      11286    11285       -1     
+ Partials     3093     3091       -2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ischoegl ischoegl requested a review from a team June 3, 2025 16:49
@ischoegl
Copy link
Member Author

ischoegl commented Jun 3, 2025

Failing windows-2019 jobs are related to a brown-out due to upcoming deprecation and removal actions/runner-images#12045

AUTHORS.md Outdated
- **Laurien Vandewalle** ([@lavdwall](https://github.com/lavdwall))
- **Guillaume Vignat** ([@gvignat](https://github.com/gvignat)), Stanford University
- **Anthony Walker** ([@anthony-walker](https://github.com/anthony-walker)), Oregon State University
- **Bryan Weber** ([@bryanwweber](https://github.com/bryanwweber)), University of Connecticut
Copy link
Member

Choose a reason for hiding this comment

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

Can you remove this affiliation? It hasn't been accurate for three and a half years now 🫣

Copy link
Member Author

@ischoegl ischoegl Jun 4, 2025

Choose a reason for hiding this comment

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

😆 yeah. I'm actually thinking of updating the top statement to:

[...] Below is a partial, alphabetical list of developers and contributors to Cantera over the years, along with their last reported affiliation. If you've been left off or need an update, please report on Cantera's Github issue tracker.

As there are presumably several other issues, the only other viable alternative would be to strip affiliations, as this will be a recurring issue.

Copy link
Member

Choose a reason for hiding this comment

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

Seems like a good update to me 😀

Copy link
Contributor

Choose a reason for hiding this comment

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

I think the affiliation can just be handled by the tagged users on their own profiles.

Copy link
Member Author

Choose a reason for hiding this comment

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

Fair point, @wandadars. I stripped the affiliations in an update, see https://github.com/ischoegl/cantera/blob/rename-authors-file/AUTHORS.md

Copy link
Member

Choose a reason for hiding this comment

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

I'd really rather we kept the affiliations. I think the suggested update to the statement at the top is reasonable, with the expectation that the affiliation is generally one that is/was applicable at the time contributions to Cantera were being made.

Copy link
Member Author

@ischoegl ischoegl Jun 4, 2025

Choose a reason for hiding this comment

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

@speth - no worries. I kept the commits separate so I just reverted. I did, however, strip the parentheses as the links are visually clearly separated from names.

ischoegl added 2 commits June 3, 2025 19:48
Also, switch to list, add links to GitHub handles, and typeset names in
bold font.
@ischoegl ischoegl force-pushed the rename-authors-file branch 3 times, most recently from 1f911f4 to a15a63c Compare June 4, 2025 16:29
@ischoegl ischoegl force-pushed the rename-authors-file branch from a15a63c to 7493320 Compare June 4, 2025 16:31
@ischoegl ischoegl requested a review from speth June 6, 2025 01:56
@ischoegl ischoegl merged commit 0ae673e into Cantera:main Jun 6, 2025
50 of 51 checks passed
@ischoegl ischoegl deleted the rename-authors-file branch June 6, 2025 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Scons fails to configure with sphinx_docs option enabled
4 participants