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

Citation.cff and citation guidelines #30

Open
MakisH opened this issue Aug 22, 2024 · 3 comments
Open

Citation.cff and citation guidelines #30

MakisH opened this issue Aug 22, 2024 · 3 comments

Comments

@MakisH
Copy link
Collaborator

MakisH commented Aug 22, 2024

Similarly to the-teachingRSE-project/competencies#253, we need a CFF file here as well.

We should also include some citation guidelines in the home page.

@MakisH MakisH changed the title Citation.cff Citation.cff and citation guidelines Aug 22, 2024
@MakisH
Copy link
Collaborator Author

MakisH commented Nov 9, 2024

In our last meeting, we also discussed having regular releases (e.g., once per semester/year) and putting those on Zenodo for archival. The DOI of each version would be different, but there is also an umbrella DOI for all versions.

@CaptainSifff given that we have papers citing this, I think it would be a good time to make a first release and put a snapshot on Zenodo. I would then go ahead and create one, unless you think otherwise.

To give credit to people, we could put the names of people that contributed to each release (or in total) on Zenodo. This is what we do, for example, in the preCICE Distribution: https://darus.uni-stuttgart.de/dataset.xhtml?persistentId=doi:10.18419/darus-4167

@CaptainSifff
Copy link
Collaborator

Let's go for zenodo. A minor complication comes here, how to deal with minor contributions like in #37 . Do we want to define, what constitutes a minimum contribution for authorship? I currently tend towards a very open model to increase reach.

@MakisH
Copy link
Collaborator Author

MakisH commented Nov 11, 2024

I think that in this project, almost all contributions will be minor by default, so why not add everyone by default. My concern would then be that there are people that contribute via issues: can we easily integrate these? Or do these then clearly fall into the same category as "We acknowledge private conversations with John Doe"? If we set the bar as low as a mention of a website, I see the danger that we would then constantly argue and just add more names.

The only pragmatic reason not to have a very long list of authors that don't really know each other could be what you observed with trying to find reviewer suggestions: it gets more complicated (in further publications) to find reviewers that have not published together with the authors. The "maximizing reach" argument is not necessarily true, I believe.

In terms of direct commits, there are very few so far, mostly in PRs suggesting additions: https://github.com/DE-RSE/learn-and-teach/graphs/contributors

In terms of the infrastructure and basic concepts/structure, my pull requests were typically reviewed by you and @jngrad, and the project evolved from discussions in our group, so I think this would be a fair starting point. The initial content I added was at large sourced from the competencies repository (mainly issues, see #11).

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

No branches or pull requests

2 participants