3 ms·

One of the features that I really like about Gitlab after moving some of my personal projects over to it is how there is a dedicated section under the title to

One of the features that I really like about Gitlab after moving some of my personal projects over to it is how there is a dedicated section under the title to display your badges, without having to put them into the README. I think that a very important feature of a good README is that the most important information is at the top of the README. Badges going in at the top of the README as images dilutes that somewhat imo, especially since most of the badges are about the repo and not necessarily about the project itself. Also Shields.io is a fantastic service, and was super helpful to me while I was setting up some badges recently - very well done UX that really switches the challenge from setting up the badges to attempting not to include too many of them due to how easy it is.

tikkabhuna 7y ago
Didn't realise Gitlab supported that. We've been putting some badges in our READMEs. Typically those from the Gitlab CI page. What does annoy me is the classic Gitlab "MVP" approach. Under Gitlab CI -> General Pipelines is some badge code I can copy. There's no mention that I can add them to the badge section of the project, nor is there anything in General -> Badges section to say "Add Pipeline status". I have to copy the link/img URLs myself.
- andr3 7y ago
  That's a great point, @tikkabhuna! It seems like fixing that problem you describe could be a good way to improve the discoverability of the mentioned Badges area. I've taken the liberty of documenting this in an issue [1] and putting forward a proposal. Would something like what I wrote there solve this problem for you? If you have any more feedback to add, feel free to drop a comment. I work as a Frontend Engineering Manager at GitLab and will raise the visibility of this issue to the right folks to get this on their radar. Thanks for mentioning this. -- [1] https://gitlab.com/gitlab-org/gitlab/issues/35771 https://gitlab.com/gitlab-org/gitlab/issues/35771
  - tikkabhuna 7y ago
    Thanks andr3. That captures my thoughts perfectly. :-) Its great to see such an open company. My boss and I frequently check Gitlab issues and look forward to release on the 22nd. :thumbsup:
rwj 7y ago
It's silly, but when I was moving some projects to SourceHut, this was one of the first things I noticed was missing.

tikkabhuna 7y ago

Didn't realise Gitlab supported that. We've been putting some badges in our READMEs. Typically those from the Gitlab CI page. What does annoy me is the classic Gitlab "MVP" approach. Under Gitlab CI -> General Pipelines is some badge code I can copy. There's no mention that I can add them to the badge section of the project, nor is there anything in General -> Badges section to say "Add Pipeline status". I have to copy the link/img URLs myself.

andr3 7y ago
That's a great point, @tikkabhuna! It seems like fixing that problem you describe could be a good way to improve the discoverability of the mentioned Badges area. I've taken the liberty of documenting this in an issue [1] and putting forward a proposal. Would something like what I wrote there solve this problem for you? If you have any more feedback to add, feel free to drop a comment. I work as a Frontend Engineering Manager at GitLab and will raise the visibility of this issue to the right folks to get this on their radar. Thanks for mentioning this. -- [1] https://gitlab.com/gitlab-org/gitlab/issues/35771 https://gitlab.com/gitlab-org/gitlab/issues/35771
- tikkabhuna 7y ago
  Thanks andr3. That captures my thoughts perfectly. :-) Its great to see such an open company. My boss and I frequently check Gitlab issues and look forward to release on the 22nd. :thumbsup:

rwj 7y ago

It's silly, but when I was moving some projects to SourceHut, this was one of the first things I noticed was missing.