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 authorship to Cookbook template #43

Merged
merged 6 commits into from
Jun 28, 2022

Conversation

brian-rose
Copy link
Member

No description provided.

@github-actions
Copy link

github-actions bot commented Jun 28, 2022

👋 Thanks for opening this PR! The Cookbook will be automatically built with GitHub Actions. To see the status of your deployment, click below.
🔍 Git commit SHA: 772badd
✅ Deployment Preview URL: https://ProjectPythiaCookbooks.github.io/cookbook-template/_preview/43

@brian-rose brian-rose marked this pull request as ready for review June 28, 2022 19:59
@brian-rose
Copy link
Member Author

This PR addresses part of ProjectPythia/cookbook-gallery#15 by adding acknowledgement of authorship to the Cookbook template.

The idea is that each Cookbook will have one or more "primary" authors credited with the science content. This part is manually added to the README.

In addition, I'm using a neat tool that dynamically adds an image with ALL contributors to the repository. Clicking on this image will bring you to the contributors graph page for the repository where you can see all the details.

This is a way to ensure that all contributors are visibly acknowledged on the rendered Cookbook itself, not just in the source repo.

Copy link
Contributor

@clyne clyne left a comment

Choose a reason for hiding this comment

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

Looks great, @brian-rose !

@ktyle
Copy link
Contributor

ktyle commented Jun 28, 2022

This looks great! I notice though that "dependabot" is included in the list of contributors ... can bots such as that be excluded from the contributor list?

@brian-rose
Copy link
Member Author

This looks great! I notice though that "dependabot" is included in the list of contributors ... can bots such as that be excluded from the contributor list?

I think that would be better, but I don't know of an easy way to make it work. I opened an issue on the tool I'm using to generate the contributors image:
lacolaco/contributors-img#1175

@ktyle
Copy link
Contributor

ktyle commented Jun 28, 2022

Understood ... I'm happy to give credit to the bots in the meantime!

@brian-rose brian-rose merged commit 64d1865 into ProjectPythia:main Jun 28, 2022
@brian-rose brian-rose deleted the add-author branch June 28, 2022 22:26
github-actions bot pushed a commit that referenced this pull request Jun 28, 2022
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