Coder Social home page Coder Social logo

github-label-builder's Introduction

Github Label Builder

This application renders SVG Labels for my use in Github Pull Request comments.

Usage

Github Markdown (Difficulty Level 2)

![Passing Question](https://your-website/passing/question.svg)
What do you think of calling this variable `subscribedTopics` or something like that, just to make it more explicit?

Passing Question

What do you think of calling this variable subscribedTopics or something like > that, just to make it more explicit?

![Optional Best Practice](https://your-website/optional/best%20practice.svg)
I would recommend we do the `console.error` BEFORE we save it to the database. That way, if the DB save also fails, we can capture both failures.

Optional Best Practice

I would recommend we do the console.error BEFORE we save it to the database. That way, if the DB save also fails, we can capture both failures.

![Blocking Danger](https://your-website/blocking/danger.svg)
If you don't `return await` here, you're not going to catch it in your `catch` here.

Blocking Danger

If you don't return await here, you're not going to catch it in your catch here.

![Passing Kudos](https://your-website/passing/kudos.svg?big)
I really like the way you did this. Awesome!

Passing Kudos

I really like the way you did this. Awesome!

Alfred Workflow (Difficulty Level 1)

If you use Alfred, I created a workflow that will compose the Markdown for you. Simply download and install the Github PR Labels.alfredworkflow in this repository.

Dialog Box: Consistency


OK, why did you make this?

In working through my fair share (and then some) of Pull Requests, I found that it because convient for me to quantify my asks, so that the person on the other end of the request understood when I was asking, when I was telling, and especially when I was doing some of both. I ended up with PRs Requesting Changes, with a mixture of comments like these:

[non-blocking]

Can you change this into a Unit Test, instead of an integration test?


[not-necessarily blocking]

What do you plan for this GraphQL schema to evolve into? Let's chat before you merge this. I think you're on the right track, but I want to make sure.


[blocking]

If you don't return await here, you're not going to catch it in your catch here.

I got tired of that, and it still wasn't very easy for me to at-a-glance show what was blocking and what wasn't. This was especially troublesome in very large Pull Requests (I know, we shouldn't have those, but we always seem to).

Enter Github Labels v1

I created a set of Github Labels (icons) that I could simply drop into my comments, which allowed me to quickly and succinctly describe both why I was putting the comment and how big of a deal it was:

Pass Question@0 5x

What do you think of calling this variable subscribedTopics or something like that, just to make it more explicit?

Optional Best Practice

I would recommend we do the console.error BEFORE we save it to the database. That way, if the DB save also fails, we can capture both failures.

Blocking Danger

If you don't return await here, you're not going to catch it in your catch here.

This was better, but I was just so frustrated that I couldn't use SVGs. Apparently, for Security Reasons, Github doesn't allow local SVGs

Enter Github Label Builder

With this project, I was able to generate SVGs remotely, so that Github would render them properly. I can use any of the "blocking", "optional", or "passing" button types, and any text (as long as it fits)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.