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

Another layout for badges #475

Merged
merged 2 commits into from
Jul 31, 2017
Merged

Another layout for badges #475

merged 2 commits into from
Jul 31, 2017

Conversation

maxmeyer
Copy link
Member

@maxmeyer maxmeyer commented Jul 31, 2017

Summary

Another layout for the build badges in the readme

Details

As pointed out in #469 I think having a talble for the build status of "master" and "still" is easier to read. But I see the point in having some kind of a "sign post" for outsiders in what kind of state the project is.

This is why I moved up the "build" bages of the "master" branch.

I also added more details to clarify the use of the branches.

Screenshots (if appropriate):

https://github.com/cucumber/aruba/tree/feature/other-layout-for-badges

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactoring (cleanup of codebase withouth changing any existing functionality)
  • Update documentation

Checklist:

  • I've added tests for my code
  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@maxmeyer maxmeyer force-pushed the feature/other-layout-for-badges branch from 57c08fd to 8c204a5 Compare July 31, 2017 20:35
@maxmeyer maxmeyer requested a review from junaruga July 31, 2017 20:36
@junaruga
Copy link
Contributor

Maybe you are a maintainer and you are going to fix current build failure/error by yourself.
I do not disagree with this.

@maxmeyer
Copy link
Member Author

Maybe you are a maintainer and you are going to fix current build failure/error by yourself.

What do you mean with this?

README.md Outdated
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://raw.githubusercontent.com/cucumber/aruba/master/LICENSE)
[![Docs](https://img.shields.io/badge/cucumber.pro-aruba-3d10af.svg)](https://app.cucumber.pro/projects/aruba)
[![Gem Version](https://badge.fury.io/rb/aruba.svg)](http://badge.fury.io/rb/aruba)
[![Dependency Status](https://gemnasium.com/cucumber/aruba.svg)](https://gemnasium.com/cucumber/aruba)
[![Code Climate](https://codeclimate.com/github/cucumber/aruba.svg)](https://codeclimate.com/github/cucumber/aruba)
[![Support](https://img.shields.io/badge/cucumber-support-orange.svg)](https://cucumber.io/support)
<br>
Copy link
Contributor

Choose a reason for hiding this comment

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

<br> HTML tag? I do not know that it makes sense for Markdown format.

Copy link
Member Author

@maxmeyer maxmeyer Jul 31, 2017

Choose a reason for hiding this comment

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

Good catch. I was not sure what the parser will do with a newline. So I took the "happy path" and just added <br> to make sure the build flags are on "their" own.

@maxmeyer maxmeyer force-pushed the feature/other-layout-for-badges branch from ab75e28 to 9b6bc6b Compare July 31, 2017 21:01
@junaruga
Copy link
Contributor

I think as you are a maintainer, it is good to update README.md and the build status as you like. Because you are a person that often see the build status.
Your opinion should be prioritized.
So, I will accept your design.

@maxmeyer
Copy link
Member Author

maxmeyer commented Jul 31, 2017

Ah ok. I was unsure if I said something impolite which I oversaw. Thanks for the feedback.

But anyway I see your point and I was not that comfortable with having the build status at the very end of the readme. Given this version in this PR it seems to be a good compromise for aruba developers and aruba users not being "disturbed" by information not interesting for that party.

It's really a good thing discussing those things and get an opinon from a different perspective. Thanks for helping making aruba better.

@maxmeyer maxmeyer merged commit f2edf8d into master Jul 31, 2017
@maxmeyer maxmeyer deleted the feature/other-layout-for-badges branch July 31, 2017 21:15
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