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.

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

Marked Defibrillator Challenge (alpha) #1107

Closed
wants to merge 6 commits into from
Closed

Marked Defibrillator Challenge (alpha) #1107

wants to merge 6 commits into from

Conversation

joshbruce
Copy link
Member

@joshbruce joshbruce commented Mar 2, 2018

Marked version: 0.3.17

Description

We don't actually know how many users we really have. Our contributors have kinda bailed on us. This should help us gauge interest beyond the core team in keeping marked around. We're getting some feedback (new issue submissions and whatnot), but not a lot of help, which is unsustainable.

  • We know we have 3,000+ dependents - don't know how many of those are actually active projects.
  • We know we get about 1M downloads a month - don't know how many sites that equates to, whether they've been updated in the last few years (I built the US Popclock page a few years ago and it is still using a now dead SVG package, Raphael)
  • We know we have 2000+ forks and no real contributions back to the mainline.

But, we don't know how many individual users we have and how interested they are in marked sticking around.

The plan

Given the possible implications (getting overrun by PRs), a rolling wave approach is proposed:

  • Start with this PR, once full consent is given from the committers + @intcreator, I will tag a few folks I think might be interested in the badge (and give them a note on why I tagged them). (Might be good if we each submitted a PR as well, you know?)
  • Committers will then tag folks they think would be interested in the badge and helping out.
  • We merge to update the README on GitHub (smaller audience than NPM, I think). Leave it there for at least 30 days.
  • If we still need tests to cover the spec, and we're still driven to keep marked going, we push a release to (NPM) primarily to notify our users (kind of our only real communication channel to them).

Ps. For committers, can y'all please start actually putting all merged PRs in the draft release?? I'm guilty myself, to be fair. I think it will help me (and our users) when publishing releases to know what all went into that release and modify marketing and communication language accordingly without having to step through commit and PR history. (Users also get the opportunity to opt-in to the most esoteric details of the release, if they want to.)

Contributor

  • Test(s) exist to ensure functionality and minimize regresstion (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

  • Draft GitHub release notes have been updated.
  • CI is green (no forced merge required).
  • Merge PR

@davisjam
Copy link
Contributor

davisjam commented Mar 2, 2018

For committers, can y'all please start actually putting all merged PRs in the draft release?

Could require an update to a "News" file as part of each PR; Travis can check for this.

That's what cpython (implementation of Python) does.

@joshbruce
Copy link
Member Author

joshbruce commented Mar 2, 2018

Could require an update to a "News" file as part of each PR; Travis can check for this.

Sounds interesting. I'm unfamiliar. Create an issue - tag @UziTech?

@davisjam: Did you get the two invites? One to the org and one to the super secret squirrel hideout?

@davisjam
Copy link
Contributor

davisjam commented Mar 2, 2018

Did you get the two invites?

Yes. My regex paper is due in a week though so I'm laying low.

@joshbruce
Copy link
Member Author

Fair. And good luck!

@davisjam
Copy link
Contributor

davisjam commented Mar 2, 2018

#1108


In case you haven't noticed, and judging by attendance you haven't… (Movie. Major League. No? Anyway.)

In case you haven't noticed, after years of [being mostly dead](https://github.com/markedjs/marked/issues/1106) (not to be confused with stable), Marked is trying to come back to life. We're about at the "You just wiggled your finger" stage ([The Princess Bride](https://youtu.be/yokQ0_8__ts). No? Come on!)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not the biggest fan of the conversation fluff. It makes me take the project less seriously.


There are four of us on the core team and we have one curious contributor helping us make moves (see [AUTHORS](https://github.com/markedjs/marked/blob/master/AUTHORS.md) page).

We've stirred the tanks a bit and, Houston, we have a problem. ([Apollo 13](https://youtu.be/Bti9_deF5gs). No? Where have y'all been!? Seriously, we haven't talked in a while, where have you been? Oh, right, better question, where has the *marked* community been? Again, mostly dead…)

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still trying to figure out if there's anything important in this README...

@intcreator
Copy link

I like the idea of inviting people to add simple test cases, but I think the description is a bit noisy. Maybe make it a bit more concise before we commit it. I think it's good for projects to be fun and casual, but this is a bit over the top for me.

So our number one priority is to be 100% CommonMark compliant for 1.0?

@joshbruce
Copy link
Member Author

joshbruce commented Mar 2, 2018

@intcreator: Want to wait for more feedback before responding further. Check out the CommonMark Compliance project and description (or let me know if you can't see it) and related epic (#1109) regarding priority. Think this is more information gathering and getting help from our friends in that endeavor.

@styfle
Copy link
Member

styfle commented Mar 2, 2018

but I think the description is a bit noisy. Maybe make it a bit more concise before we commit it.

I get the same feeling with a lot of the docs.

@joshbruce
Copy link
Member Author

joshbruce commented Mar 2, 2018

@intcreator and @styfle: Thank you for the feedback. In all honesty, I could be overcompensating.

I'm a pretty big believer in Conway's Law - probably why I focus a lot on the "individuals and interactions" piece of Agile Software Development.

So, let me ask the question - especially, but not limited to @intcreator and @davisjam:

  • What made you show up in the first place (never saw you in the comments, or not enough to be noticeable at least)?
  • What made you want to help?

Note: I've read literally hundreds of issues and PRs and have a pretty decent understanding of the history of the community for the project, I think...that's why I don't remember seeing a lot of these names or faces there.

[edit] Also might be why I could be overcompensating with the relaxed or "not so serious" side of things.

@joshbruce
Copy link
Member Author

Also, by approving this via review, we are not committing to a merge...only me tagging a bunch of folks as a first wave test case. (Just want to be clear.)

@joshbruce
Copy link
Member Author

Maybe this LOTR reference would be more appropriate... https://youtu.be/jDBPmEAheCY - granted, given what the community devolved into...not sure where the marked brand stands right now.

@joshbruce
Copy link
Member Author

Closing. Scaling too soon.

@joshbruce joshbruce closed this Mar 5, 2018
@joshbruce joshbruce deleted the defibrillator-challenge branch March 5, 2018 13:05
@intcreator
Copy link

intcreator commented Mar 5, 2018

I started looking at Marked because I'm using Polymer's <marked-element> to display Markdown on some of my sites (such as my Web Audio API tutorial) and I wanted to fix a certain bug. It looks like that's a long ways away though because I'd have to understand the entire 5 year old implementation first.

Because the cost is so high, I may instead create my own Polymer element that implements the Commonmark.js parser. If it works, then I'll start focusing more on my web audio API project again.

This leads me to a question—is there anything that Marked does that Commonmark.js doesn't?

@styfle
Copy link
Member

styfle commented Mar 5, 2018

@intcreator Yes. I don't believe commonmark.js supports GitHub Flavored Markdown (GFM)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants