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.

Sign up for GitHub

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

Jump to bottom

Update authors #1105

Merged
merged 19 commits into from
Mar 2, 2018
Merged

Update authors #1105

Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
cac4863
Gamification of authors and badges
Mar 1, 2018
967adbc
Inline anchors and minor correction
Mar 1, 2018
0ab7253
Make new paragraph
Mar 1, 2018
56e1bc0
Minor comdey
Mar 1, 2018
03dcc26
Adding to add
Mar 1, 2018
8328e06
Make task list
Mar 1, 2018
d9107ec
Change to ordered list
Mar 1, 2018
cfec9ba
Well, unordered lists don't work...bummer
Mar 1, 2018
1164b52
Minor grammar
Mar 1, 2018
962b41b
Typos
Mar 1, 2018
1e34ae2
Typo
Mar 1, 2018
a1b4404
Removing a badge reasons
Mar 1, 2018
327275c
DRI for merging the badge PR
Mar 1, 2018
ee0a2ac
Minor phrasing
Mar 1, 2018
d2c8154
Add further instruction
Mar 1, 2018
0b05047
Add instructions
Mar 1, 2018
67ffd5a
Grammar
Mar 1, 2018
5d1ba58
Updated based on feedback
Mar 2, 2018
73ac57d
GFM compiler doesn't seem to parse links inside blockquotes??
Mar 2, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/PULL_REQUEST_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,10 @@

If release PR, add ?template=release.md to the PR url to use the release PR template.

Otherwise, you are stating the this PR fixes an issue that has been submitted; or,
describes the issue or proposal under considersation.
If badging PR, add ?template=badges.md to the PR url to use the badges PR template.

Otherwise, you are stating this PR fixes an issue that has been submitted; or,
describes the issue or proposal under considersation and contains the project-related code to implement.

-->

Expand All @@ -18,6 +20,8 @@

<!--

If no issue exists that you're aware of. The maintainers should be able to figure out if it's a duplicate.

## Expectation

Describe the output you are expecting from marked
Expand Down
45 changes: 45 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/badges.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
**@mention the contributor:**

This is a recommendation to:

- [ ] Add a badge
- [ ] Remove a badge

<!--

Explain your reasoning behind tagging that person.

Preferably by citing objective examples, like PRs, Issues, and so on.

-->

If you're the one mentioned in this PR:

- [ ] whether you will accept the badge or not; or,
- [ ] whether you will or will not dispute the recommendation to remove

within 30 days (silence is consent at this point, can't have the pull requests page filled with PRs related to badges forever).

<!--

Why would someone not accept a badge? Loads of reasons depending on the circumstances.

1. If you're a committer and someone puts a badge for you on having decision making authority in an area, do you really a) think you earned it and b) think you can do that *and* all the other stuff you got going as a committer, admin, or publisher (not to even mention your outside life)? Maybe not. And that's okay. Thank them for the recognition, explain you aren't able to take more on at the moment. It's cool to get recognized though.
2. Maybe you don't feel you actually earned it yet. I remember being in an interview once. The interviewer asked me to give an example of going above and beyond the call of duty. I said, "That's hard. Because what you consider going above and beyond may be what I consider to be 'just rising to'. If we're in battle and you get wounded and I pull you out of the frey before heading back into it, I don't consider that going above and beyond; I consider that rising to."

Why would someone remove their own badge? Loads of reasons...

1. Maybe you got a lot going on right now and want to broadcast to the Marked community that, "Hey, I don't want to say I'm going to do this unless I can really commit to it right now in a way that serves the project well." That's awesome! That takes courage! Because a) saying "no" is hard for most humans ("people pleasers") and b) the alternative, well, for those of us here since about October of 2017 (and prior), we know what the alternative can look like.
2. Maybe you just think you've done all you can to help and learned all you can from the experience. Again, very awesome and courageous. It takes courage to know when to walk away on your own accord.

Why would you want to remove someone's badge? Loads of reasons...

1. Maybe they have decision making authority on something. You asked for their advice. And, you ended up waiting almost a month before receiving a response.
2. Maybe it was relevant at the time (Master of Marked, for example) but you think they've lost their former level of skill (fell out of practice, for example). They could always get it back.
3. Maybe to signal to them that, "Hey, you seem to have forgotten about us. Are you still around (or alive)?"

Anyway, you get the idea. This isn't about good or bad...it's just about giving the community a simple game mechanic by which to publicly say, "Thank you" or "Here's what my status is" in the community or "Hey, I think something's wrong here" in a civil manner.

-->

Note: All committers must approve via review before merging, the disapproving committer can simply close the PR.
99 changes: 82 additions & 17 deletions AUTHORS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Marked takes an encompassing approach to its community. As such, you can think o

## Users

Users are anyone using Marked in some fashion.
Users are anyone using Marked in some fashion, without them, there's no reason for us to exist.

To be listed: please let us know or submit a PR.

Expand All @@ -14,34 +14,37 @@ To be removed: please let us know or submit a PR.

Contributors are users who submit a [PR](https://github.com/markedjs/marked/pulls), [Issue](https://github.com/markedjs/marked/issues), or collaborate in making Marked a better product and experience for all the users.

|Name |GitHub handle |Title and knowledge |
|:-------------------|:----------------|:---------------------------------------------------------------------|
|Karen Yavine |@karenyavine |Snyk's Security Saint (helps keep us out of the security penalty box) |
|Federico Soave |@Feder1co5oave |Regent of the Regex, Master of Marked (demonstrates extreme knowledge in how Marked works) |
|Brandon der Blätter |@intcreator |Curious Contributor (new contributor asking questions and suggesting things resulting in positive movement) |
|Костя Третяк |@KostyaTretyak |-- |
|Name |GitHub handle |Badge of honor |
|:-------------------|:----------------|:-------------------------------------|
|Karen Yavine |@karenyavine |Snyk's Security Saint |
|Federico Soave |@Feder1co5oave |Regent of the Regex, Master of Marked |
|Brandon der Blätter |@intcreator |Curious Contributor |
|Костя Третяк |@KostyaTretyak |-- |

To be listed: make a contribution and, if it has significant impact, the committers may be able to add you here.

To be removed: please let us know or submit a PR.

[Details on badges](#badges)

## Committers

Committers are contributors who also have the responsibility, privilege, some might even say burden of being able to review and merge contributions (just usually not their own).

A note on "decision making authority". This is related to submitting PRs and the [advice process](http://www.reinventingorganizationswiki.com/Decision_Making). The person marked as having decision making authority over a certain area should be sought for advice in that area before committing to a course of action.

|Name |GiHub handle |Area(s) of decision making authority and knowledge |
|:--------------|:--------------|:------------------------------------------------------------------------|
|Tony Brix |@UziTech |Titan of the test harness and Dr. DevOps |
|Steven |@styfle |Open source, of course and GitHub Guru |
|Jamie Davis |@davisjam |Seeker of Security |
|?? |?? |Eye for the CLI, Markdown Maestro, Regent of the Regex, Master of Marked |
|Name |GiHub handle |Decision making |Badges of honor (tag for questions) |
|:--------------|:--------------|:----------------------------------------|------------------------------------|
|Tony Brix |@UziTech |Titan of the test harness and Dr. DevOps | |
|Steven |@styfle |Open source, of course and GitHub Guru | |
|Jamie Davis |@davisjam |Seeker of Security | |

To be listed: Committers are usually selected from contributors who enter the discussions regarding the future direction of Marked (maybe even doing informal reviews of contributions despite not being able to merge them yourself).

To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/).

[Details on badges](#badges)

## Admins

Admins are committers who also have the responsibility, privilege, and burden of selecting committers and making sure the project itself runs smoothly, which includes community maintenance, governance, dispute resolution, and so on. (Letting the contributors easily enter into, and work within, the project to begin contributing, with as little friction as possible.)
Expand All @@ -50,18 +53,80 @@ To be listed: Admins are usually selected from the pool of committers who demons

To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/).

[Details on badges](#badges)

## Publishers

Publishers are admins who also have the responsibility, privilege, and burden of publishing the new releases to NPMJS and performing outreach and external stakeholder communications. Further, when things go pear-shaped, they're the ones taking most of the heat. Finally, when things go well, they're the primary ones praising the contributors who made it possible.
Publishers are admins who also have the responsibility, privilege, and burden of publishing the new releases to NPM and performing outreach and external stakeholder communications. Further, when things go pear-shaped, they're the ones taking most of the heat. Finally, when things go well, they're the primary ones praising the contributors who made it possible.

(In other words, while Admins are focused primarily on the internal workings of the project, Publishers are focused on internal *and* external concerns.)

|Name | GitHub handle |Area(s) of decision making authority and knowledge |
|:----------|:--------------|:-----------------------------------------------------------|
|Josh Bruce |@joshbruce |Humaning Helper, Heckler of Hypertext, and Release Wrangler |
|Name |GitHub handle |Decision making |Badges of honor (tag for questions) |
|:----------|:--------------|:------------------------|:-------------------------------------|
|Josh Bruce |@joshbruce |Release Wrangler |Humaning Helper, Heckler of Hypertext |

[Details on badges](#badges)

## Original author

The original author is the publisher who started it all.

Christopher Jeffrey @chjj

<h2 id="badges">Badges</h2>

Badges? You don't *need* no stinkin' badges.

Movie references aside. (It was either that or, "Let's play a game", but that would have been creepy&hellip;that's why it will most likely come later.)

Badges? If you *want* 'em, we got 'em, and here's how you get 'em (and&hellip;dramatic pause&hellip;why not two dramatic pauses for emphasis?&hellip; how they can be taken away).

- [ ] Add the appropriate badge to the desired contributor in the desired column of this page, even if they're not listed here yet.
- [ ] Submit a PR (we're big on PRs around here, if you haven't noticed, help us help you).
- [ ] Follow the instructions for submitting a badge PR. (There are more details to find within. Come on. Everybody likes surprises, right? No? Actually, we just try to put documentation where it belongs, closer to the code and part of the sequence of events.)

Badges at play:

<dl>
<dt>Curious Contributor</dt>
<dd>A contributor with less than one year on this page who is actively engaged in submitting PRs, Issues, making recommendations, sharing thoughts&hellip;without being too annoying about it (let's be clear, submitting 100 Issues recommending the Marked Committers send everyone candy is trying for the badge, not honestly earning it).</dd>
<dt>Dr. DevOps</dt>
<dd>
<p>Someone who understands and contributes to improving the developer experience and flow of Marked into the world.</p>
<blockquote>
"The main characteristic of the DevOps movement is to strongly advocate automation and monitoring at all steps of software construction, from integration, testing, releasing to deployment and infrastructure management. DevOps aims at shorter development cycles, increased deployment frequency, more dependable releases, in close alignment with business objectives." ~ [Wikipedia](https://en.wikipedia.org/wiki/DevOps)
</blockquote>
</dd>
<dt>Eye for the CLI</dt>
<dd>At this point? Pretty much anyone who can update that `man` file to the current Marked version without regression in the CLI tool itself.</dd>
<dt>GitHub Guru</dt>
<dd>Someone who always seems to be able to tell you easier ways to do things with GitHub.</dd>
<dt>Humaning Helper</dt>
<dd>Someone who goes out of their way to help contributors feel welcomed and valued. Further, someone who takes the extra steps(s) necessary to help new contributors get up to speed. Finally, they maintain composure even in times of disagreement and dispute resolution.</dd>
<dt>Heckler of Hypertext</dt>
<dd>Someone who demonstrates an esoteric level of knowledge when it comes to HTML. In other words, someone who says things like, "Did you know most Markdown flavors don't have a way to render a description list (`dl`)? All the more reason Markdown `!==` HTML."</dd>
<dt>Markdown Maestro</dt>
<dd>You know that person who knows about way too many different flavors of Markdown? The one who maybe seems a little too obsessed with the possibilities of Markdown beyond HTML? Come on. You know who they are. Or, at least you could, if you give them this badge.</dd>
<dt>Master of Marked</dt>
<dd>Someone who demonstrates they know the ins and outs of the codebase for Marked.</dd>
<dt>Open source, of course</dt>
<dd>Someone who advocates for and has a proven understanding of how to operate within open source communities.</dd>
<dt>Regent of the Regex</dt>
<dd><p>Can you demonstrate you understand the following without Google and Stackoverflow?</p>
<p><code>/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/</code></p>
<p>Because this author can't yet. That's who gets these.</p>
</dd>
<dt>Seeker of Security</dt>
<dd>Someone who has demonstrated a high degree of expertise or authority when it comes to software security.</dd>
<dt>Titan of the Test Harness</dt>
<dd>Someone who demonstrates high-levels of understanding regarding Marked's test harness.</dd>
</dl>

Special badges that come with the job:

<dl>
<dt>Release Wrangler</dt>
<dd>This is a badge given to all Publishers.</dd>
<dt>Snyk's Security Saint</dt>
<dd>This is a badge given to whomever primarily reaches out from Snyk to let us know about security issues.</dd>
</dl>