micro-editor / micro-editor/micro
Documentation: plugin / core split
Nobody has claimed this yet.
- Dominant language
- Go
- Stars
- 29.6k
- Forks
- 1.4k
- Avg merge
- 2d 18h
- Merged PRs (30d)
- 10
Description
I don't see any separate design documentation (and I didn't look in the source beyond what I needed so far),
Are there any guidelines for what functionality should be in Go and what should be done in plugins?
I'd probably want to maximize what's in plugins, modulo performance critical operations, but I don't know about the architecture of micro.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the repository's existing documentation and the Go and plugin architecture in the source. Identify the boundary between core and plugins, then document guidelines for deciding where functionality belongs, including performance-critical exceptions. Done means contributors can use the documentation to make that split consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- go
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100