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

DOC Update authors #205

Merged
merged 1 commit into from
Sep 10, 2020
Merged

DOC Update authors #205

merged 1 commit into from
Sep 10, 2020

Conversation

MarcoGorelli
Copy link
Collaborator

If more contributors come by we can make a script, but for now this is fine.

Else, @s-weigand , do you feel like making a PR to have the "all contributors specification" show up, as in your flake8-nb repo?

Copy link
Contributor

@s-weigand s-weigand left a comment

Choose a reason for hiding this comment

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

LGTM

@s-weigand
Copy link
Contributor

About 'all contributors'

Specifications

The specifications are created by a bot (CLI, under the hood), so no need to create them manually.

Needed changes

For all contributors to work the Readme.rst, would need to be changed to a README.md.
Luckily mixing *.md and *.rst (especially when the *.md file is in the parent directory of docs), got a lot easier thanks to MyST-Parser.

Implementations

I'm using the github app for the bot to listen to comments.
But there also seems to a github action for it nowadays, which might be preferable since you can just copy a workflow file across projects compared to changing settings in a web interface.

Badge

Also, due to the way the badge is parsed it needs to be on a new line, but luckily @JoeIzzard already provided a solution for that, by creating a new badge which auto updates.

@s-weigand s-weigand mentioned this pull request Sep 10, 2020
@MarcoGorelli MarcoGorelli merged commit 9d99c1b into master Sep 10, 2020
@MarcoGorelli MarcoGorelli deleted the update-authors branch September 10, 2020 12:11
@s-weigand s-weigand mentioned this pull request Sep 10, 2020
@JoeIzzard
Copy link

@s-weigand Glad the badge is of help! Haven't had a chance to look at fixing the issue in the all-contributors bot but at least you should be able to manually edit it.

@s-weigand
Copy link
Contributor

@JoeIzzard Thanks a lot ❤️
Since I normally group my badges by context (i.e. releases+license, test+coverage+docs, QA+rest), the line break due to the comment tags with the original badge from the bot did quite annoy me. So removed the comment tags and updated the badge manually, each time I added a contributor.
Luckily I found your new badge in an issue and since then replaced the old one everywhere 😄

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