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 table and instructions for how to update #1649

Merged

Conversation

edwardchalstrey1
Copy link
Contributor

@edwardchalstrey1 edwardchalstrey1 commented Oct 19, 2023

✅ Checklist

  • You have given your pull request a meaningful title (e.g. Enable foobar integration rather than 515 foobar).
  • You are targeting the appropriate branch. If you're not certain which one this is, it should be develop.
  • Your branch is up-to-date with the target branch (it probably was when you started, but it may have changed since then).
  • You have marked this pull request as a draft and added '[WIP]' to the title if needed (if you're not yet ready to merge).

⤴️ Summary

Adds README table and badge, plus instructions that link to https://allcontributors.org/docs/en/cli/overview

Copy link
Member

@JimMadge JimMadge left a comment

Choose a reason for hiding this comment

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

Good idea (why haven't we done this already!?!).

If you install the CLI you should be able to test this locally.

.all-contributorsrc Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@edwardchalstrey1
Copy link
Contributor Author

Closing this for now as per Martin's comment on slack:

I approved and then disapproved the all-contributors bot as it needs write access to code, which we’ve decided we won’t allow for the DSH codebase as part of our controls over who can make changes to the codebase.

@JimMadge I guess if you were keen to have this then this can reopened later after a discussion with the team

@JimMadge
Copy link
Member

@edwardchalstrey1 Good point, the distinction between pinned actions and an unpinned bot is a little subtle but important.

However, I think we can still use all contributors and should reopen this PR. We can commit to using the all contributors CLI to manager the contributors table. I think that is still better than what we currently do. Any workflows we could add to ensure consistency or try and spot missing contributors would be great.

The contributing docs could be updated to say don't use the bot, but ask a maintainer.

Copy link
Member

@JimMadge JimMadge left a comment

Choose a reason for hiding this comment

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

This is looking great.

A couple of things I think we should do,

  • On the preview the contributors page appears under a "More" drop down in the menu bar. Can we make it more visible? Maybe there is a theme option for number of items before the drop down?
  • I think we should take the approach of low threshold to contribution. There are more contribution types that we could acknowledge. Would you like me to have a go at updating the contributions?
  • It would be worth asking in our Slack channels for contributors we might have missed. Especially contributions which don't appear in the commit history like funding, training, conversations, bug reports.

@JimMadge JimMadge force-pushed the add-all-contributors branch from 49bb961 to 8c992bd Compare October 24, 2023 15:10
@edwardchalstrey1
Copy link
Contributor Author

On the preview the contributors page appears under a "More" drop down in the menu bar. Can we make it more visible? Maybe there is a theme option for number of items before the drop down?

Done

README.md Outdated Show resolved Hide resolved
@JimMadge JimMadge force-pushed the add-all-contributors branch from dfb8fb5 to c371f31 Compare November 2, 2023 11:40
@JimMadge JimMadge merged commit 94f1bcf into alan-turing-institute:develop Nov 2, 2023
10 checks passed
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.

2 participants