Skip to content

v2 Project: Motivation and path. #6

Open
@ddavness

Description

@ddavness

v2 Roadmap

The problem

Currently, the code is in spaghetti form, with clear inefficiencies regarding the use of HttpService and a dangerously soft line between fetching data from Trello and sending data to Trello.
Also, there are inconsistencies in argument checking that we need to fix.

In the end, the refactoring that would be required would be too much for a remake to be a valid option

Fundamental principles of v2

  • Git-like approach to the problem that sits in three basic operations:

    • Fetch data from Trello;
    • Make changes locally;
    • Push data to Trello.
  • A caching system in order to support larger-scale games;

  • Gracious error handling for errors that might be out of user control (404's, 429's, 500's);

  • Proper error messages that are easy to understand (I recommend to see this article).

Nice-to-haves:

  • Compatibility with Rojo;
  • For Roblox-TS users: An NPM package will be developed in parallel by me;
  • We will begin also shipping v2 modules in the Roblox Website so that you don't have to snoop in the releases page.
  • ADDED 29TH JULY: Module will be documented with Documentation Reader (by @ProbableAI) styling.

Versioning:

Until a version is stable, we will name dev releases of v2 2.0.0-dev.X

Metadata

Metadata

Labels

majorWork guidelines for a major version release

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions