diff --git a/docs/AUTHORS.md b/docs/AUTHORS.md index d44bf5f0eb..0bf00ead41 100644 --- a/docs/AUTHORS.md +++ b/docs/AUTHORS.md @@ -1,40 +1,146 @@ # Authors -Marked takes an encompassing approach to its community. As such, you can think of these as [concentric circles](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951), where each subsequent group is enveloped by the previous one. +Marked takes an encompassing approach to its community. As such, you can think of these as [concentric circles](https://medium.com/the-node-js-collection/healthy-open-source-967fa8be7951), where each group encompases the following groups. + + + + + + + + + + + + + + +
+ + + +
+ Christopher Jeffrey +
Original Author
+ Started the fire + 		+ + + +
+ Josh Bruce +
Publisher
+ Release Wrangler; Humaning Helper; Heckler of Hypertext + 		+ + + +
+ Steven +
Admin
+ Open source, of course; GitHub Guru; Humaning Helper +
+ + + +
+ Jamie Davis +
Committer
+ Seeker of Security + 		+ + + +
+ Tony Brix +
Committer
+ Titan of the test harness; Dr. DevOps + 		+   +
+ + + + + + + + + + + + + + +
+ + + +
+ Brandon der Blätter +
Contributor
+ Curious Contributor + 		+ + + +
+ Carlos Valle +
Contributor
+ Maker of the Marked mark from 2018 to present + 		+ + + +
+ Federico Soave +
Contributor
+ Regent of the Regex; Master of Marked +
+ + + +
+ Karen Yavine +
Contributor
+ Snyk's Security Saint + 		+ + + +
+ Костя Третяк +
Contributor
+ + 		+ + + +
+ Tom Theisen +
Contributor
+ Defibrillator +
-## Users - -Users are anyone using Marked in some fashion, without them, there's no reason for us to exist. +## Publishers -|Individual or Organization |Website |Project |Submitted by | -|:--------------------------|:-----------------------|:------------------------------------|:---------------------------------------------------| -|MarkedJS |https://marked.js.org |https://github.com/markedjs/marked |The marked committers | +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. -To be listed: All fields are optional. Contact any of the committers or, more timely, submit a pull request with the following (using the first row as an example): +(In other words, while Admins are focused primarily on the internal workings of the project, Publishers are focused on internal *and* external concerns.) -- **Individual or Organization:** The name you would like associated with the record. -- **Website:** A URL to a standalone website for the project. -- **Project:** A URL for the repository of the project using marked. -- **Submitted by:** The name and optional honorifics for the person adding the listing. +**Should not exceed 2:** Having more people with the authority to publish a release can quickly turn into a consensus seeking nightmare (design by committee). Having only one is preferred (Directly Responsible Individual); however, given the nature of the project and its history, having an immediate fallback, and a potential deep fallback (Original author) is probably a good idea. -To be removed: Same as above. Only instead of requesting addition request deletion or delete the row yourself. +[Details on badges](#badges) -## Contributors +## Admins -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. +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.) -|Name |GitHub handle |Badge of honor | -|:-------------------|:----------------|:---------------------------------------------| -|Brandon der Blätter |@intcreator |Curious Contributor | -|Carlos Valle |@carlosvalle |Maker of the Marked mark from 2018 to present | -|Federico Soave |@Feder1co5oave |Regent of the Regex, Master of Marked | -|Karen Yavine |@karenyavine |Snyk's Security Saint | -|Костя Третяк |@KostyaTretyak |-- | -|Tom Theisen |@tomtheisen |Defibrillator | +**Should not exceed 3:** When there are too many people with the ability to resolve disputes, the dispute itself can quickly turn into a dispute amongst the admins themselves; therefore, we want this group to be small enough to commit to action and large enough to not put too much burden on one person. (Should ensure faster resolution and responsiveness.) -To be listed: make a contribution and, if it has significant impact, the committers may be able to add you here. +To be listed: Admins are usually selected from the pool of committers (or they volunteer, using the same process) who demonstrate good understanding of the marked culture, operations, and do their best to help new contributors get up to speed on how to contribute effectively to the project. -To be removed: please let us know or submit a PR. +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) @@ -44,11 +150,6 @@ Committers are contributors who also have the responsibility, privilege, some mi 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 |GitHub handle |Decision making |Badges of honor (tag for questions) | -|:--------------|:---------------|:----------------------------------------|:------------------------------------| -|Jamie Davis |@davisjam |Seeker of Security | | -|Tony Brix |@UziTech |Titan of the test harness and Dr. DevOps | | - **Should not exceed 5:** For larger PRs affecting more of the codebase and, most likely, review by more people, we try to keep this pool small and responsive and let those with decision making authority have final say without negative repercussions from the other committers. To be listed: Committers are usually selected (or they volunteer, using the same process) 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). @@ -63,41 +164,32 @@ A note on volunteering: [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.) - -|Name |GitHub handle |Decision making |Badges of honor (tag for questions) | -|:--------------|:---------------|:----------------------------------------|:------------------------------------| -|Steven |@styfle |Open source, of course and GitHub Guru |Humaning Helper | +## Contributors -**Should not exceed 3:** When there are too many people with the ability to reolves disputes, the dispute itself can quickly turn into a dispute amongst the admins themselves; therefore, we want this group to be small enough to commit to action and large enough to not put too much burden on one person. (Should ensure faster resolution and responsiveness.) +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. -To be listed: Admins are usually selected from the pool of committers (or they volunteer, using the same process) who demonstrate good understanding of the marked culture, operations, and do their best to help new contributors get up to speed on how to contribute effectively to the project. +To be listed: make a contribution and, if it has significant impact, the committers may be able to add you here. -To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/). +To be removed: please let us know or submit a PR. [Details on badges](#badges) -## Publishers - -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 |Decision making |Badges of honor (tag for questions) | -|:----------|:--------------|:------------------------|:-------------------------------------| -|Josh Bruce |@joshbruce |Release Wrangler |Humaning Helper, Heckler of Hypertext | +## Users -**Should not exceed 2:** Having more people with the authority to publish a release can quickly turn into a consensus seeking nightmare (design by committee). Having only one is preferred (Directly Responsible Individual); however, given the nature of the project and its history, having an immediate fallback, and a potential deep fallback (Original author) is probably a good idea. +Users are anyone using Marked in some fashion, without them, there's no reason for us to exist. -[Details on badges](#badges) +|Individual or Organization |Website |Project |Submitted by | +|:--------------------------|:-----------------------|:------------------------------------|:---------------------------------------------------| +|MarkedJS |https://marked.js.org |https://github.com/markedjs/marked |The marked committers | -## Original author +To be listed: All fields are optional. Contact any of the committers or, more timely, submit a pull request with the following (using the first row as an example): -The original author is the publisher who started it all. +- **Individual or Organization:** The name you would like associated with the record. +- **Website:** A URL to a standalone website for the project. +- **Project:** A URL for the repository of the project using marked. +- **Submitted by:** The name and optional honorifics for the person adding the listing. -Christopher Jeffrey @chjj +To be removed: Same as above. Only instead of requesting addition request deletion or delete the row yourself.

Badges