Skip to content

Commit ff87873

Browse files
authored
Merge pull request #1105 from joshbruce/update-authors
Update authors
2 parents a139051 + 73ac57d commit ff87873

File tree

3 files changed

+133
-19
lines changed

3 files changed

+133
-19
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,10 @@
33
44
If release PR, add ?template=release.md to the PR url to use the release PR template.
55
6-
Otherwise, you are stating the this PR fixes an issue that has been submitted; or,
7-
describes the issue or proposal under considersation.
6+
If badging PR, add ?template=badges.md to the PR url to use the badges PR template.
7+
8+
Otherwise, you are stating this PR fixes an issue that has been submitted; or,
9+
describes the issue or proposal under considersation and contains the project-related code to implement.
810
911
-->
1012

@@ -18,6 +20,8 @@
1820

1921
<!--
2022
23+
If no issue exists that you're aware of. The maintainers should be able to figure out if it's a duplicate.
24+
2125
## Expectation
2226
2327
Describe the output you are expecting from marked
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
**@mention the contributor:**
2+
3+
This is a recommendation to:
4+
5+
- [ ] Add a badge
6+
- [ ] Remove a badge
7+
8+
<!--
9+
10+
Explain your reasoning behind tagging that person.
11+
12+
Preferably by citing objective examples, like PRs, Issues, and so on.
13+
14+
-->
15+
16+
If you're the one mentioned in this PR:
17+
18+
- [ ] whether you will accept the badge or not; or,
19+
- [ ] whether you will or will not dispute the recommendation to remove
20+
21+
within 30 days (silence is consent at this point, can't have the pull requests page filled with PRs related to badges forever).
22+
23+
<!--
24+
25+
Why would someone not accept a badge? Loads of reasons depending on the circumstances.
26+
27+
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.
28+
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."
29+
30+
Why would someone remove their own badge? Loads of reasons...
31+
32+
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.
33+
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.
34+
35+
Why would you want to remove someone's badge? Loads of reasons...
36+
37+
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.
38+
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.
39+
3. Maybe to signal to them that, "Hey, you seem to have forgotten about us. Are you still around (or alive)?"
40+
41+
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.
42+
43+
-->
44+
45+
Note: All committers must approve via review before merging, the disapproving committer can simply close the PR.

AUTHORS.md

Lines changed: 82 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Marked takes an encompassing approach to its community. As such, you can think o
44

55
## Users
66

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

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

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

1515
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.
1616

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

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

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

28+
[Details on badges](#badges)
29+
2830
## Committers
2931

3032
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).
3133

3234
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.
3335

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

4142
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).
4243

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

46+
[Details on badges](#badges)
47+
4548
## Admins
4649

4750
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.)
@@ -50,18 +53,80 @@ To be listed: Admins are usually selected from the pool of committers who demons
5053

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

56+
[Details on badges](#badges)
57+
5358
## Publishers
5459

55-
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.
60+
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.
5661

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

59-
|Name | GitHub handle |Area(s) of decision making authority and knowledge |
60-
|:----------|:--------------|:-----------------------------------------------------------|
61-
|Josh Bruce |@joshbruce |Humaning Helper, Heckler of Hypertext, and Release Wrangler |
64+
|Name |GitHub handle |Decision making |Badges of honor (tag for questions) |
65+
|:----------|:--------------|:------------------------|:-------------------------------------|
66+
|Josh Bruce |@joshbruce |Release Wrangler |Humaning Helper, Heckler of Hypertext |
67+
68+
[Details on badges](#badges)
6269

6370
## Original author
6471

6572
The original author is the publisher who started it all.
6673

6774
Christopher Jeffrey @chjj
75+
76+
<h2 id="badges">Badges</h2>
77+
78+
Badges? You don't *need* no stinkin' badges.
79+
80+
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.)
81+
82+
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).
83+
84+
- [ ] Add the appropriate badge to the desired contributor in the desired column of this page, even if they're not listed here yet.
85+
- [ ] Submit a PR (we're big on PRs around here, if you haven't noticed, help us help you).
86+
- [ ] 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.)
87+
88+
Badges at play:
89+
90+
<dl>
91+
<dt>Curious Contributor</dt>
92+
<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>
93+
<dt>Dr. DevOps</dt>
94+
<dd>
95+
<p>Someone who understands and contributes to improving the developer experience and flow of Marked into the world.</p>
96+
<blockquote>
97+
"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." ~ <a href="https://en.wikipedia.org/wiki/DevOps">Wikipedia</a>
98+
</blockquote>
99+
</dd>
100+
<dt>Eye for the CLI</dt>
101+
<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>
102+
<dt>GitHub Guru</dt>
103+
<dd>Someone who always seems to be able to tell you easier ways to do things with GitHub.</dd>
104+
<dt>Humaning Helper</dt>
105+
<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>
106+
<dt>Heckler of Hypertext</dt>
107+
<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>
108+
<dt>Markdown Maestro</dt>
109+
<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>
110+
<dt>Master of Marked</dt>
111+
<dd>Someone who demonstrates they know the ins and outs of the codebase for Marked.</dd>
112+
<dt>Open source, of course</dt>
113+
<dd>Someone who advocates for and has a proven understanding of how to operate within open source communities.</dd>
114+
<dt>Regent of the Regex</dt>
115+
<dd><p>Can you demonstrate you understand the following without Google and Stackoverflow?</p>
116+
<p><code>/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/</code></p>
117+
<p>Because this author can't yet. That's who gets these.</p>
118+
</dd>
119+
<dt>Seeker of Security</dt>
120+
<dd>Someone who has demonstrated a high degree of expertise or authority when it comes to software security.</dd>
121+
<dt>Titan of the Test Harness</dt>
122+
<dd>Someone who demonstrates high-levels of understanding regarding Marked's test harness.</dd>
123+
</dl>
124+
125+
Special badges that come with the job:
126+
127+
<dl>
128+
<dt>Release Wrangler</dt>
129+
<dd>This is a badge given to all Publishers.</dd>
130+
<dt>Snyk's Security Saint</dt>
131+
<dd>This is a badge given to whomever primarily reaches out from Snyk to let us know about security issues.</dd>
132+
</dl>

0 commit comments

Comments
 (0)