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

Use consistent branch names in README.md #135

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

liontiger23
Copy link

Previously examples were inconsistent between workflow examples and points bar code examples

Previously examples were inconsistent between workflow examples and points bar code examples
@markpatterson27
Copy link
Owner

@liontiger23 Thank you for the PR.

The branch name is configurable so that users can choose their preferred naming convention. Do you think that having different branch names in the examples is confusing for new users trying to setup points bar in their own repo?

I wonder if a better solution would be adding guidence on using a different branch name (i.e. matching workflow ignore, checkout and blob path)?

Your opinions on this would be valuable.

@@ -209,7 +209,7 @@ To display the points bar, add the following to the top of the assignment README
If you want to float the points bar to the right, use the following instead:

```html
<img alt="points bar" align="right" height="36" src="../../blob/status/.github/badges/points-bar.svg" />
<img alt="points bar" align="right" height="36" src="../../blob/badges/.github/badges/points-bar.svg" />
Copy link
Author

Choose a reason for hiding this comment

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

This was by far the biggest point of confusion for me.

Both previous code snippets were copy-pasteable, so everything would work "out-of-the-box". So I assumed the same for this <img> example, but it failed, and I had to go dig into URL to find out why.

The changes below were just to ensure that the same snippets will work for reusable workflow as well.

@liontiger23
Copy link
Author

liontiger23 commented May 26, 2024

I wonder if a better solution would be adding guidence on using a different branch name (i.e. matching workflow ignore, checkout and blob path)?

To highlight the ability to change the branch, and make it visible to new user, it would probably better to use status as example branch, so that it stands out (since the path to .svg also contains badges --- /blob/badges/.github/badges/points-bar.svg).
I would think after that, a note about replacing status branch with a different one will be enough.

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