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

docs: seed allcontributor data #162

Merged
merged 4 commits into from
Oct 18, 2019

Conversation

kharaone
Copy link
Contributor

Issue #100

Initial seed commit to initiate the data for allcontributor bot / cli
Provide an example to proceed with other repositories

Changes

  • Inserted seed bash script
    • usage: ./scripts/seed_contributors.sh NAME TOKEN REPONAME

Copy link
Member

@mttrbrts mttrbrts left a comment

Choose a reason for hiding this comment

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

Thanks @kharaone, just a couple of small changes and I'm happy to merge. 👍

scripts/seed_contributors.sh Outdated Show resolved Hide resolved
README.md Outdated
[apache]: https://github.com/accordproject/template-studio-v2/blob/master/LICENSE
[creativecommons]: http://creativecommons.org/licenses/by/4.0/
<h1 align="center">
[![All Contributors](https://img.shields.io/badge/all_contributors-24-orange.svg?style=flat-square)](#contributors-)
Copy link
Member

Choose a reason for hiding this comment

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

This doesn't render correctly,
image

Badges should sit below the AP logo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

the way the library detects the badge zone (in order to update it) is through a regex var badgeRegex = /\[!\[All Contributors\]\([a-zA-Z0-9\-./_:?=]+\)\]\(#[\w-]+\)/;, BUT markdown doesn't mix well with html.
I'll keep the logo centered, but I will need to move the badges on the left. Is that acceptable?

Copy link
Member

Choose a reason for hiding this comment

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

Perhaps you can just empty the badgeTemplate config parameter, i.e. in .all-contributorsrc:

"badgeTemplate": "",

Copy link
Contributor Author

@kharaone kharaone Oct 15, 2019

Choose a reason for hiding this comment

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

it will only drive the rewriting of the badge to nothing ^^.
The library has hardcoded the regex to be the markdown tag. You can just change what's it's replaced with.

In order to "fix" this, we would need to PR to the allcontributor, to expose the regex in the options or leverage a block section like it does for the contributor list

Signed-off-by: kharaone <kharaone@gmail.com>
Signed-off-by: Karim Adala <kadala@blizzard.com>
Signed-off-by: Karim Adala <kadala@blizzard.com>
contributor badge needs to be markdown but can't be mixed with html.
Moving the badges to their own line without alignment to fix this

Signed-off-by: Karim Adala <kadala@blizzard.com>
@irmerk
Copy link
Member

irmerk commented Oct 17, 2019

Please notify the related issue when this is merged to kickstart the process in other repos.

@kharaone
Copy link
Contributor Author

I created all-contributors/cli#210 to alleviate @mttrbrts 's concerns. However, I still feel that this PR could go through whether or not it's merged.

Hacktoberfest 2019 automation moved this from In Progress PR to Approved PR Oct 18, 2019
@mttrbrts
Copy link
Member

@kharaone great work pushing the upstream PR too. I'm happy to merge this one as is for now.

🥇

@mttrbrts mttrbrts merged commit f9d6e82 into accordproject:master Oct 18, 2019
Hacktoberfest 2019 automation moved this from Approved PR to Finished PR Oct 18, 2019
@irmerk irmerk mentioned this pull request Dec 20, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Difficulty: Medium hacktoberfest by DigitalOcean and DEV Type: Feature Request 🛍️ New feature or request
Projects
No open projects
Hacktoberfest 2019
  
Finished PR
Development

Successfully merging this pull request may close these issues.

None yet

3 participants