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

Add all-contributors bot and update CITATION.cff #63

Merged
merged 4 commits into from
Jul 3, 2024

Conversation

anissa111
Copy link
Member

PR Summary

  • adds DOI to CITATION.cff
  • Sets up all-contributors bot with .all-contributorsrc
  • Starts contributor section of README.md

Notes:

  • I contemplated using "content" instead of "code" here, but the "code" emoji will link to commits made by each contributor, which feels more tangibly useful
  • I tried not to think too hard about contribution types for each of us. If I've missed something or chosen a weird category, let me know and I'll change it!
  • See what it looks like live on my fork's README

Related Tickets & Documents

Part of #59

PR Checklist

General

  • PR includes a summary of changes
  • Link relevant issues, make one if none exist

Copy link

github-actions bot commented Jun 26, 2024

Meowdy! See your PR preview:
🔍 Git commit SHA: 903dab9
✅ Deployment Preview URL: https://NCAR.github.io/geocat-applications/_preview/63

Copy link
Contributor

@cyschneck cyschneck left a comment

Choose a reason for hiding this comment

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

So will Code will cover the general documentation? One of the keys is Tutorials, would that cover these kind of pages?

@anissa111
Copy link
Member Author

So will Code will cover the general documentation? One of the keys is Tutorials, would that cover these kind of pages?

I imagined "code" describing anything that adds content to to the site, as the core code of this project is the content, you know? I thought about "tutorials", but figured we should save that for any actual tutorials we run in the future.

I've interpreted "docs" to mean anything that's not content on the site.

CITATION.cff Outdated
@@ -24,5 +24,10 @@ authors:
family-names: Zacharias
affiliation: NSF NCAR
orcid: 'https://orcid.org/0000-0002-2666-8493'
- name: GeoCAT Community Contributors
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think I'd advocate for explicitly including folks (especially for the time being while it's pretty easy to manage) and decoupling the all contributors stuff from the citation (i.e removing this for now and manually syncing the info).

That said, I'm curious what the intent was here - is it trying to tie in some metadata about who contributed what?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh! Maybe I misunderstood the conclusions from our last meeting convo.

So, yes, I had intended that we explicitly include folks that contribute to the level of "authorship". This here is just for also linking to non-authorship contributions (and, I suppose who contributed what metadata for official "authorship" contributors).

Copy link
Collaborator

Choose a reason for hiding this comment

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

Would you be opposed to leaving it out for now? I think it's a little confusing since it's effectively the same people, but infers maybe an authors and others categorization. This is maybe a me thing though so if you prefer this way I think it's fine.

Copy link
Member Author

Choose a reason for hiding this comment

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

I don't have strong feelings here, we can always add it back later if the people listed in both meaningfully diverges.

repository-code: 'https://github.com/NCAR/geocat-applications'
identifiers:
- type: doi
value: 10.5281/zenodo.12555371
Copy link
Collaborator

Choose a reason for hiding this comment

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

🎉

<table>
<tbody>
<tr>
<td align="center" valign="top" width="14.28%"><a href="https://github.com/anissa111"><img src="https://avatars.githubusercontent.com/u/38434768?v=4?s=75" width="75px;" alt="Anissa Zacharias"/><br /><sub><b>Anissa Zacharias</b></sub></a><br /><a href="#infra-anissa111" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/NCAR/geocat-applications/commits?author=anissa111" title="Code">💻</a> <a href="#ideas-anissa111" title="Ideas, Planning, & Feedback">🤔</a></td>
Copy link
Collaborator

Choose a reason for hiding this comment

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

I agree the code vs docs thing is murky, but this seems like a great start!

Thanks for putting this all together!

@anissa111 anissa111 requested review from kafitzgerald and removed request for kafitzgerald July 3, 2024 17:44
@anissa111 anissa111 merged commit 042df78 into NCAR:main Jul 3, 2024
2 checks passed
@anissa111 anissa111 deleted the all-contrib-bot branch July 3, 2024 17:51
github-actions bot pushed a commit that referenced this pull request Jul 3, 2024
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.

3 participants