Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add header image #62

Merged
merged 5 commits into from
Apr 19, 2023
Merged

Add header image #62

merged 5 commits into from
Apr 19, 2023

Conversation

jcbhmr
Copy link
Contributor

@jcbhmr jcbhmr commented Apr 13, 2023

this pr would...

  • add a header image
  • not touch anything else

closes #39

@jcbhmr
Copy link
Contributor Author

jcbhmr commented Apr 13, 2023

@spenserblack ready for review

also consider dropping the "Features" header. maybe even combine the emoji list with the test status badge?

🌐 Works across repositories (with a [PAT])
📚 Pretty interface for Markdown docs
⤴️ Lets you open PRs for wiki docs
💻 Supports runs-on: windows-*
Test

or

🌐 Works across repositories (with a [PAT])
📚 Pretty interface for Markdown docs
⤴️ Lets you open PRs for wiki docs
💻 Supports runs-on: windows-*
🧪

@spenserblack
Copy link
Owner

also consider dropping the "Features" header. maybe even combine the emoji list with the test status badge?

Yeah, I'm fine dropping the features header. I think the picture tells enough of a story.

Copy link
Owner

@spenserblack spenserblack left a comment

Choose a reason for hiding this comment

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

LGTM, but are you planning to make any more changes, like dropping the features section like you mentioned?

@jcbhmr
Copy link
Contributor Author

jcbhmr commented Apr 19, 2023

LGTM, but are you planning to make any more changes, like dropping the features section like you mentioned?

@spenserblack yep

how does this look?

image
https://github.com/jcbhmr/actions-wiki/tree/patch-5#readme

specifically: where should the Test badge go (if anywhere)?

@spenserblack
Copy link
Owner

where should the Test badge go

Personally, I like badges for the most important aspects of the project (CI/Tests passing, package version, etc.) up at the top, right under the title. It's where I've put badges in pretty much every project, and also where I've seen badges in other projects.

As a user, seeing a nice "tests pass" badge at the top before I even start reading the docs is reassuring.

@jcbhmr
Copy link
Contributor Author

jcbhmr commented Apr 19, 2023

where should the Test badge go

Personally, I like badges for the most important aspects of the project (CI/Tests passing, package version, etc.) up at the top, right under the title. It's where I've put badges in pretty much every project, and also where I've seen badges in other projects.

As a user, seeing a nice "tests pass" badge at the top before I even start reading the docs is reassuring.

i like to see it in the commit log thing
image

but i agree seeing green is reassuring

@jcbhmr
Copy link
Contributor Author

jcbhmr commented Apr 19, 2023

@spenserblack i made it like you want:

image

ready2merge

@spenserblack spenserblack merged commit 3e696e6 into spenserblack:main Apr 19, 2023
@jcbhmr jcbhmr deleted the patch-5 branch April 19, 2023 18:31
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a header image to readme
2 participants