haltu/muuri

Opinions wanted on the API

Open

#166 opened on May 2, 2018

View on GitHub
 (21 comments) (0 reactions) (0 assignees)JavaScript (10,630 stars) (668 forks)batch import
help wantedquestion

Description

Hey everyone, I hope you're enjoying Muuri so far!

I'm currently refactoring Muuri's core to make it faster and easier on the memory. While at it I've been reviewing a lot of the internal functionality and thought a lot about the current API. There are some things I'd like to change, but before going deeper into that I would appreciate any feedback on the current state of API. What are the good parts and what are the bad parts? Is there something that won't be missed if removed etc?

Contributor guide

Tech stack
javascript
Domain
api
Issue type
research
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic understanding of Muuri
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
This issue is a discussion about the Muuri API. A contributor should read through the current API documentation and comments in the issue, then provide their opinion on which parts of the API are good or bad. The maintainer is looking for feedback on potential removals or changes. No specific code changes are required.
Opinions wanted on the API · haltu/muuri#166 | Good First Issue