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

Update dev team documentation #1455

Open
gonuke opened this issue Jun 23, 2022 · 8 comments
Open

Update dev team documentation #1455

gonuke opened this issue Jun 23, 2022 · 8 comments
Labels

Comments

@gonuke
Copy link
Contributor

gonuke commented Jun 23, 2022

Describe the Bug

Current dev_team.rst does not include all contributors

To Reproduce

Compare information in docs/dev_team.rst to data in https://github.com/pyne/pyne/graphs/contributors.

Expected Behavior

Documented dev team should include all contributors.

@gonuke gonuke changed the title Update dev team Update dev team documentation Jun 23, 2022
@shimwell
Copy link
Contributor

shimwell commented Jun 23, 2022

If this is being redone then we could consider moving to a new format.

I think GitHub in general is now moving to a CITATION.cff file in the root folder of the repo. Then it gets picked up by GitHub and generates automatic citation text for latex etc.

https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files

We have such a file on the DAGMC repo as a example https://github.com/svalinn/DAGMC/blob/develop/CITATION.cff

@bam241
Copy link
Member

bam241 commented Jun 23, 2022

@shimwell do you know how the order is determined? Is it random?

It feels wrong to have my name first on a DAGMC contributor list ;)

@shimwell
Copy link
Contributor

@bam241 it was sorted by commits. You are also top of this list https://github.com/svalinn/DAGMC/graphs/contributors

@bam241
Copy link
Member

bam241 commented Jun 23, 2022

I feel like number of commits are a flowed flawed metric...

I cannot claim by far that as I am one of the main contributor of DAGMC

@shimwell
Copy link
Contributor

Other easy options (GitHub has a drop down menu for) are lines added, lines deleted.

I think commits is the default as some repos squash the commits when merging a PR.

@gonuke
Copy link
Contributor Author

gonuke commented Jul 8, 2022

This is still manually maintained, right? So it means new contributors should add their name to this file? (Could we test for that?)

@gonuke
Copy link
Contributor Author

gonuke commented Jul 8, 2022

Author ordering is complex and probably deserves a community discussion/policy

@gonuke
Copy link
Contributor Author

gonuke commented Jul 22, 2023

I'm not sure that CITATION.cff should necessarily supersede up-to-date documentation on who has contributed, unless one can be automatically generated from the other?

@gonuke gonuke added the docs label Jul 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants