Giters

markedjs / marked

A markdown parser and compiler. Built for speed.

Home Page:https://marked.js.org

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

You're friend here is only mostly dead...

joshbruce opened this issue · comments

commented

Marked version: 0.3.17

See next: #1522

Your friend here is only mostly dead. And, mostly dead, is slightly alive

^^ There's a YouTube video behind there

On December 1, 2017 we started working to analyze and bring marked back to life. Feedback in #956 was pretty positive; so, we kept pressing forward.

Around February 16, 2018 @chjj moved marked to the MarkedJS organizational account, giving us the opportunity to manage the project more effectively in a self-organizing and self-managing way.

Over the course of that time we have managed to:

  1. Add continuous integration.
  2. Analyzed, triaged, and closed hundreds of pull requests and issues.
  3. Fix some of the defects (including another discovered security vulnerability).
  4. And establish a basic roadmap for the future.

Where we are and where we're going

We realize that, if this revival is going to work it cannot be one person (or even four people) doing most of the work; it's simply not sustainable.

Therefore, we would like to let you know where we are, what the plan is (at this moment), and ask you to help any way you can (even if it's just fixing a typo). There are only four of us on the core team; therefore, we prefer that if you see something that needs fixed, please submit a PR that fixes it (this will let us focus on the bigger picture and problems).

  1. The only thing that is time-sensitive on this revival effort is a security vulnerability. See README.
  2. Our current test bed does not seem to adequately reflect or cover the supported specifications. If it were able to cover it, we would not have the number of tickets we do concerning not being compliant with those specs. Further, there may be areas of the specifications we will not be able to comply with for whatever reason (see #1036). Finally, we will be focusing our efforts on getting marked to be as spec-compliant as we can before focusing on user issues (as we believe spec-compliance will cover a lot of those issues). If you would like to help, please comment below and we'll reach out when we're ready.
  3. Once we have performed the necessary analysis to get a more objective understanding of where we are regarding spec compliance, we may or may not turn our attention to the other user submitted issues.

Until then

  1. We will have three milestones: 0.x, 1.x, and 2.x (the 0.4, 0.5, and 0.6 will remain open; however, they should be considered deprecated until such time as the tickets associated with them have been re-evaluated). These milestones will contain the high-level (epic) goals and boundaries for each of those major releases (see "epic" label).
  2. We will have project boards related to each of those active epics to make it easier for the maintainers to see where things are. These boards will be automated; so, no need to drag and drop, it's just easier for us to get insight into what's going on and the help of the revival project overall.
  3. Committers will do their best to flag PRs and issues with a project, to let you know what major release you can expect something to happen in (if at all, flagging for a release is not commitment). (Please be patient, there's only four of us right now, and we all have a lot of other things going on, if you would like to help, comment in the issue and PR what major release you think that issue or PR belongs in.)

Our promise

We've received feedback regarding semantic versioning and a desire from our users to push a 1.0 release. We cannot, in good conscience, push a 1.0 release that does not effectively cover the supported specifications (and other reasons). Therefore, we will not remove or alter anything from the public API as of 0.3.17 (we may add to it though); however, we cannot guarantee that the output and behavior you've been receiving will remain the same.

If you run a project dependent on marked, please modify your declaration to a specific version not whatever the latest is (*) to help smooth the transition for your users.

If you have any questions, comments, or concerns, please tag @joshbruce.

Thank you for your interest and support of marked over the years. We're doing our best to bring it back to life and ensure a long, lustrous, and stable future from both a community and code perspective.

commented

Note: Flagging something for a release is not committing marked to it...just gives us a way to prioritize and filter to stay focused.