From e3489ca1c8e6a669c8b650c256655361a6303b36 Mon Sep 17 00:00:00 2001 From: Josh Bruce Date: Tue, 20 Mar 2018 16:14:44 -0400 Subject: [PATCH 1/5] Add marked mark maker badge --- AUTHORS.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/AUTHORS.md b/AUTHORS.md index 094b42bc..3773d743 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -97,7 +97,7 @@ Badges? If you *want* 'em, we got 'em, and here's how you get 'em (and…dr - [ ] 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: +### Badges at play:
Curious Contributor
@@ -136,9 +136,11 @@ Badges at play:
Someone who demonstrates they are willing and able to "fight for the users", both developers dependent on marked to do their jobs as well as end-users interacting with the output (particularly in the realm of those with the disabilities).
-Special badges that come with the job: +### Special badges that come with the job:
+
Maker of the Marked mark
+
This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Marked mark maker from 2017 to present**, for example.
Release Wrangler
This is a badge given to all Publishers.
Snyk's Security Saint
From 682b9c62b8f8e0b967245785d4ccfdf5b31b58dc Mon Sep 17 00:00:00 2001 From: Josh Bruce Date: Tue, 20 Mar 2018 16:21:36 -0400 Subject: [PATCH 2/5] grammar --- AUTHORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index 3773d743..80f97d6a 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -140,7 +140,7 @@ Badges? If you *want* 'em, we got 'em, and here's how you get 'em (and…dr
Maker of the Marked mark
-
This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Marked mark maker from 2017 to present**, for example.
+
This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.
Release Wrangler
This is a badge given to all Publishers.
Snyk's Security Saint
From 341d128bee128c07179a9c278fcf08068992b448 Mon Sep 17 00:00:00 2001 From: Josh Bruce Date: Tue, 20 Mar 2018 20:19:26 -0400 Subject: [PATCH 3/5] Merge branch 'master' into update-badges --- docs/AUTHORS.md | 148 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 148 insertions(+) create mode 100644 docs/AUTHORS.md diff --git a/docs/AUTHORS.md b/docs/AUTHORS.md new file mode 100644 index 00000000..80f97d6a --- /dev/null +++ b/docs/AUTHORS.md @@ -0,0 +1,148 @@ +# 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. + +## Users + +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. + +To be removed: please let us know or submit a PR. + +## Contributors + +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 |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 |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 | | + +**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). + +To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/). + +A note on volunteering: + +1. Please do not volunteer unless you believe you can demonstrate to your peers you can do the work required. +2. Please do not overcommit yourself; we count on those committed to the project to be responsive. Really consider, with all you have going on, wehther you able to really commit to it. +3. Don't let the previous frighten you away, it can always be changed later by you or your peers. + +[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.) + +**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.) + +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: 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 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 | + +**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. + +[Details on badges](#badges) + +## Original author + +The original author is the publisher who started it all. + +Christopher Jeffrey @chjj + +

Badges

+ +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…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…dramatic pause…why not two dramatic pauses for emphasis?… 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: + +
+
Curious Contributor
+
A contributor with less than one year on this page who is actively engaged in submitting PRs, Issues, making recommendations, sharing thoughts…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).
+
Dr. DevOps
+
+

Someone who understands and contributes to improving the developer experience and flow of Marked into the world.

+
+ "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 +
+
+
Eye for the CLI
+
At this point? Pretty much anyone who can update that `man` file to the current Marked version without regression in the CLI tool itself.
+
GitHub Guru
+
Someone who always seems to be able to tell you easier ways to do things with GitHub.
+
Humaning Helper
+
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.
+
Heckler of Hypertext
+
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."
+
Markdown Maestro
+
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.
+
Master of Marked
+
Someone who demonstrates they know the ins and outs of the codebase for Marked.
+
Open source, of course
+
Someone who advocates for and has a proven understanding of how to operate within open source communities.
+
Regent of the Regex
+

Can you demonstrate you understand the following without Google and Stackoverflow?

+

/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/

+

Because this author can't yet. That's who gets these.

+
+
Seeker of Security
+
Someone who has demonstrated a high degree of expertise or authority when it comes to software security.
+
Titan of the Test Harness
+
Someone who demonstrates high-levels of understanding regarding Marked's test harness.
+
Totally Tron
+
Someone who demonstrates they are willing and able to "fight for the users", both developers dependent on marked to do their jobs as well as end-users interacting with the output (particularly in the realm of those with the disabilities).
+
+ +### Special badges that come with the job: + +
+
Maker of the Marked mark
+
This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.
+
Release Wrangler
+
This is a badge given to all Publishers.
+
Snyk's Security Saint
+
This is a badge given to whomever primarily reaches out from Snyk to let us know about security issues.
+
From 265d6c1b3909b95401caf97a20376b2d52fb0f0c Mon Sep 17 00:00:00 2001 From: Josh Bruce Date: Tue, 20 Mar 2018 20:20:31 -0400 Subject: [PATCH 4/5] pre-commit --- README.md | 64 ++------- docs/CNAME | 1 + CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md | 2 +- CONTRIBUTING.md => docs/CONTRIBUTING.md | 8 +- PUBLISHING.md => docs/PUBLISHING.md | 2 +- docs/README.md | 99 +++++++++++++ USING_ADVANCED.md => docs/USING_ADVANCED.md | 0 USING_PRO.md => docs/USING_PRO.md | 0 {doc => docs}/broken.md | 0 docs/img/logo-black-and-white.svg | 133 ++++++++++++++++++ docs/img/logo-black.svg | 32 +++++ docs/index.html | 107 ++++++++++++++ 12 files changed, 387 insertions(+), 61 deletions(-) create mode 100644 docs/CNAME rename CODE_OF_CONDUCT.md => docs/CODE_OF_CONDUCT.md (96%) rename CONTRIBUTING.md => docs/CONTRIBUTING.md (85%) rename PUBLISHING.md => docs/PUBLISHING.md (94%) create mode 100644 docs/README.md rename USING_ADVANCED.md => docs/USING_ADVANCED.md (100%) rename USING_PRO.md => docs/USING_PRO.md (100%) rename {doc => docs}/broken.md (100%) create mode 100644 docs/img/logo-black-and-white.svg create mode 100644 docs/img/logo-black.svg create mode 100644 docs/index.html diff --git a/README.md b/README.md index 96ee203b..57f72074 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,19 @@ - - -

Marked

+# Marked Marked is -1. built for speed.* -2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.** -3. light-weight while implementing all markdown features from the supported flavors & specifications.*** +1. built for speed. +2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time. +3. light-weight while implementing all markdown features from the supported flavors & specifications. 4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects. -

* Still working on metrics for comparative analysis and definition.
-** As few dependencies as possible.
-*** Strict compliance could result in slower processing when running comparative benchmarking.

- -

Installation

+## Installation **CLI:** `npm install -g marked` **In-browser:** `npm install marked --save` -

Usage

+## Usage **CLI** @@ -48,52 +33,21 @@ $ cat hello.html Marked in the browser - +
``` -Marked offers [advanced configurations](https://github.com/markedjs/marked/blob/master/USING_ADVANCED.md) and [extensibility](https://github.com/markedjs/marked/blob/master/USING_PRO.md) as well. -

Supported Markdown specifications

- -We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors). - -|Flavor |Version | -|:----------------------------------------------------------|:----------| -|The original markdown.pl |-- | -|[CommonMark](http://spec.commonmark.org/0.28/) |0.28 | -|[GitHub Flavored Markdown](https://github.github.com/gfm/) |0.28 | - -By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community. - -

Security

- -The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously. - -Therefore, please disclose potential security issues by email to the project [committers](https://github.com/markedjs/marked/blob/master/AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue). - -

Contributing

- -The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](https://github.com/markedjs/marked/blob/master/CONTRIBUTING.md) for more details. - -For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md). - -

Authors

- -For list of credited authors and contributors, please see our [authors page](https://github.com/markedjs/marked/blob/master/AUTHORS.md). - -

License

+## License Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) -See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details. - diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 00000000..c92fdfcb --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +marked.js.org diff --git a/CODE_OF_CONDUCT.md b/docs/CODE_OF_CONDUCT.md similarity index 96% rename from CODE_OF_CONDUCT.md rename to docs/CODE_OF_CONDUCT.md index 3fe8c89a..077c0fc7 100644 --- a/CODE_OF_CONDUCT.md +++ b/docs/CODE_OF_CONDUCT.md @@ -55,7 +55,7 @@ further defined and clarified by project maintainers. ## Enforcement Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported by contacting the project team by submitting a PR with changes to the [AUTHORS](https://github.com/markedjs/marked/blob/master/AUTHORS.md) page (or emailing josh@8fold.com). All +reported by contacting the project team by submitting a PR with changes to the [AUTHORS](AUTHORS.md) page (or emailing josh@8fold.com). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. diff --git a/CONTRIBUTING.md b/docs/CONTRIBUTING.md similarity index 85% rename from CONTRIBUTING.md rename to docs/CONTRIBUTING.md index 9fbb4950..d2198554 100644 --- a/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -25,15 +25,15 @@ The following table lists the ticket type labels we use when there is work to be |Ticket type label |Description | |:----------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------| |L0 - security |A security vulnerability within the Marked library is discovered. | -|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](https://github.com/markedjs/marked/blob/master/AUTHORS.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. | +|L1 - broken |Valid usage results in incorrect output compared to [supported specifications](AUTHORS.md#specifications) OR causes marked to crash AND there is no known workaround for the issue. | |L2 - annoying |Similar to L1 - broken only there is a known workaround avaialable for the issue. | |RR - refactor and re-engineer |Results in an improvement to developers using Marked (improved readability) or end-users (faster performance) or both. | -|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](https://github.com/markedjs/marked/blob/master/AUTHORS.md#specifications)| +|NFS - new feature (spec related) |A capability Marked does not currently provide but is in one of the [supported specifications](AUTHORS.md#specifications)| |NFU - new feature (user requested) |A capability Marked does not currently provide but has been requested by users of Marked. | ## Test early, often, and everything -We try to write test cases to validate output (writing tests based on the [supported specifications](https://github.com/markedjs/marked/blob/master/AUTHORS.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness. +We try to write test cases to validate output (writing tests based on the [supported specifications](AUTHORS.md#specifications)) and minimize regression (writing tests for issues fixed). Therefore, if you would like to contribute, some things you should know regarding the test harness. |Location |Description | |:-------------|:---------------------------------------------------| @@ -92,4 +92,4 @@ npm run build ## Publishing -Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](https://github.com/markedjs/marked/blob/master/PUBLISHING.md). +Creating GitHub releases and publishing to NPM is limited to conributors and owners. If you would like more information, please see our [publishing documentation](PUBLISHING.md). diff --git a/PUBLISHING.md b/docs/PUBLISHING.md similarity index 94% rename from PUBLISHING.md rename to docs/PUBLISHING.md index 82a45d4b..4732fdf7 100644 --- a/PUBLISHING.md +++ b/docs/PUBLISHING.md @@ -1,6 +1,6 @@ # Releasing Marked -- [ ] See [contributing](https://github.com/markedjs/marked/blob/master/CONTRIBUTING.md) +- [ ] See [contributing](CONTRIBUTING.md) - [ ] Create release branch from `master` (`release-x.y.z`) - [ ] Submit PR with minimal name: Release x.y.z - [ ] Complete PR checklists diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..95dacd51 --- /dev/null +++ b/docs/README.md @@ -0,0 +1,99 @@ + + +

Marked

+ +Marked is + +1. built for speed.* +2. a low-level markdown compiler that allows frequent parsing of large chunks of markdown without caching or blocking for long periods of time.** +3. light-weight while implementing all markdown features from the supported flavors & specifications.*** +4. available as a command line interface (CLI) and running in client- or server-side JavaScript projects. + +

* Still working on metrics for comparative analysis and definition.
+** As few dependencies as possible.
+*** Strict compliance could result in slower processing when running comparative benchmarking.

+ +

Installation

+ +**CLI:** `npm install -g marked` + +**In-browser:** `npm install marked --save` + +

Usage

+ +**CLI** + +``` bash +$ marked -o hello.html +hello world +^D +$ cat hello.html +

hello world

+``` + +**Browser** + +```html + + + + + Marked in the browser + + + +
+ + + +``` + + +Marked offers [advanced configurations](USING_ADVANCED.md) and [extensibility](USING_PRO.md) as well. + +

Supported Markdown specifications

+ +We actively support the features of the following [Markdown flavors](https://github.com/commonmark/CommonMark/wiki/Markdown-Flavors). + +|Flavor |Version | +|:----------------------------------------------------------|:----------| +|The original markdown.pl |-- | +|[CommonMark](http://spec.commonmark.org/0.28/) |0.28 | +|[GitHub Flavored Markdown](https://github.github.com/gfm/) |0.28 | + +By supporting the above Markdown flavors, it's possible that Marked can help you use other flavors as well; however, these are not actively supported by the community. + +

Security

+ +The only completely secure system is the one that doesn't exist in the first place. Having said that, we take the security of Marked very seriously. + +Therefore, please disclose potential security issues by email to the project [committers](AUTHORS.md) as well as the [listed owners within NPM](https://docs.npmjs.com/cli/owner). We will provide an initial assessment of security reports within 48 hours and should apply patches within 2 weeks (also, feel free to contribute a fix for the issue). + +

Contributing

+ +The marked community enjoys a spirit of collaboration and contribution from all comers. Whether you're just getting started with Markdown, JavaScript, and Marked or you're a veteran with it all figured out, we're here to help each other improve as professionals while helping Marked improve technically. Please see our [contributing documentation](CONTRIBUTING.md) for more details. + +For our Contribution License Agreement, see our [license](https://github.com/markedjs/marked/blob/master/LICENSE.md). + +

Authors

+ +For list of credited authors and contributors, please see our [authors page](AUTHORS.md). + +

License

+ +Copyright (c) 2011-2018, Christopher Jeffrey. (MIT License) + +See [license](https://github.com/markedjs/marked/blob/master/LICENSE.md) for more details. + diff --git a/USING_ADVANCED.md b/docs/USING_ADVANCED.md similarity index 100% rename from USING_ADVANCED.md rename to docs/USING_ADVANCED.md diff --git a/USING_PRO.md b/docs/USING_PRO.md similarity index 100% rename from USING_PRO.md rename to docs/USING_PRO.md diff --git a/doc/broken.md b/docs/broken.md similarity index 100% rename from doc/broken.md rename to docs/broken.md diff --git a/docs/img/logo-black-and-white.svg b/docs/img/logo-black-and-white.svg new file mode 100644 index 00000000..5f6c0b78 --- /dev/null +++ b/docs/img/logo-black-and-white.svg @@ -0,0 +1,133 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/img/logo-black.svg b/docs/img/logo-black.svg new file mode 100644 index 00000000..a67fb80e --- /dev/null +++ b/docs/img/logo-black.svg @@ -0,0 +1,32 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..5be59468 --- /dev/null +++ b/docs/index.html @@ -0,0 +1,107 @@ + + + + + Marked.js Documentation + + + +
+
+ +

Marked.js Documentation

+
+ +
+
+ + + + + + \ No newline at end of file From 044683b12a49a20a736e9369d375f9328c52190d Mon Sep 17 00:00:00 2001 From: Josh Bruce Date: Tue, 20 Mar 2018 20:23:24 -0400 Subject: [PATCH 5/5] Remove Authors ~Head --- docs/AUTHORS.md~HEAD | 148 ------------------------------------------- 1 file changed, 148 deletions(-) delete mode 100644 docs/AUTHORS.md~HEAD diff --git a/docs/AUTHORS.md~HEAD b/docs/AUTHORS.md~HEAD deleted file mode 100644 index 80f97d6a..00000000 --- a/docs/AUTHORS.md~HEAD +++ /dev/null @@ -1,148 +0,0 @@ -# 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. - -## Users - -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. - -To be removed: please let us know or submit a PR. - -## Contributors - -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 |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 |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 | | - -**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). - -To be removed: You can remove yourself through the [GitHub UI](https://help.github.com/articles/removing-yourself-from-a-collaborator-s-repository/). - -A note on volunteering: - -1. Please do not volunteer unless you believe you can demonstrate to your peers you can do the work required. -2. Please do not overcommit yourself; we count on those committed to the project to be responsive. Really consider, with all you have going on, wehther you able to really commit to it. -3. Don't let the previous frighten you away, it can always be changed later by you or your peers. - -[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.) - -**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.) - -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: 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 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 | - -**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. - -[Details on badges](#badges) - -## Original author - -The original author is the publisher who started it all. - -Christopher Jeffrey @chjj - -

Badges

- -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…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…dramatic pause…why not two dramatic pauses for emphasis?… 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: - -
-
Curious Contributor
-
A contributor with less than one year on this page who is actively engaged in submitting PRs, Issues, making recommendations, sharing thoughts…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).
-
Dr. DevOps
-
-

Someone who understands and contributes to improving the developer experience and flow of Marked into the world.

-
- "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 -
-
-
Eye for the CLI
-
At this point? Pretty much anyone who can update that `man` file to the current Marked version without regression in the CLI tool itself.
-
GitHub Guru
-
Someone who always seems to be able to tell you easier ways to do things with GitHub.
-
Humaning Helper
-
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.
-
Heckler of Hypertext
-
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."
-
Markdown Maestro
-
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.
-
Master of Marked
-
Someone who demonstrates they know the ins and outs of the codebase for Marked.
-
Open source, of course
-
Someone who advocates for and has a proven understanding of how to operate within open source communities.
-
Regent of the Regex
-

Can you demonstrate you understand the following without Google and Stackoverflow?

-

/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/

-

Because this author can't yet. That's who gets these.

-
-
Seeker of Security
-
Someone who has demonstrated a high degree of expertise or authority when it comes to software security.
-
Titan of the Test Harness
-
Someone who demonstrates high-levels of understanding regarding Marked's test harness.
-
Totally Tron
-
Someone who demonstrates they are willing and able to "fight for the users", both developers dependent on marked to do their jobs as well as end-users interacting with the output (particularly in the realm of those with the disabilities).
-
- -### Special badges that come with the job: - -
-
Maker of the Marked mark
-
This badge is given to the person or oganization credited with creating the logo (or logotype) used in Marked communications for a given period of time. **Maker of the Marked mark from 2017 to present**, for example.
-
Release Wrangler
-
This is a badge given to all Publishers.
-
Snyk's Security Saint
-
This is a badge given to whomever primarily reaches out from Snyk to let us know about security issues.
-