Automattic / Automattic/monk

Maintainance

Open
#348 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
1.8k
Forks
180
PR merge metrics
No merged PRs in 30d

Description

Hello everyone.

I like using monk, as it's quite a good library. However, I've been distressed about the status of the project, particularly of the fact that it's been years without it seeing activity. This is hence why I'm planning to contribute through a series of Pull Requests, but wanted to talk about it first here, so I can get some insight and advice.

I already have a local branch with some of the changes, and I'll list all planned changes here to see if they are desirable or useful:

- [ ] Switch to ESM (instead of CommonJS)
- [ ] Use ES6 Classes, instead of `Object.prototype.function` hacks
- [ ] Drop callback support in support for promises
- [ ] Update the `mongo` package to the latest version
- [ ] Use [c8](https://github.com/bcoe/c8) instead of `nyc` for testing. `nyc` doesn't support ESM and isn't really maintained.
- [ ] Convert the repository to a monorepo, to easily maintain the middleware

I'm looking for feedback, and if the maintainers agree, I can start by creating the new PRs.

Contributor guide

No contributing guide indexed for this repository

Research direction

The issue names no files, tests, or entry points. Start by reviewing the proposed ESM, class, promise, Mongo package, test-runner, and monorepo changes, then seek maintainer agreement on scope; done would be a clearly agreed plan before creating the proposed series of pull requests.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, mongodb
Domain
backend, databases
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.