Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

v2 Project: Motivation and path. #6

Open
ddavness opened this issue Jul 27, 2019 · 6 comments
Open

v2 Project: Motivation and path. #6

ddavness opened this issue Jul 27, 2019 · 6 comments
Assignees
Labels
major Work guidelines for a major version release
Milestone

Comments

@ddavness
Copy link
Collaborator

ddavness commented Jul 27, 2019

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

@ddavness ddavness added the major Work guidelines for a major version release label Jul 27, 2019
@ddavness ddavness added this to the v2 milestone Jul 27, 2019
@ddavness ddavness pinned this issue Jul 28, 2019
@ddavness
Copy link
Collaborator Author

ADDED 29TH JULY: Module will be documented with Documentation Reader (by @ProbableAI) styling.

@HypheX
Copy link
Owner

HypheX commented Jul 29, 2019

This was my first OOP project ever, so it is messy as heck.
v2 won't be rushed, like v1 was.

@ddavness
Copy link
Collaborator Author

ddavness commented Sep 4, 2019

First public preview: https://github.com/HypheX/roblox-trello/releases/tag/2.0.0-dev.6

Feel free to comment on my API design choices.

@ddavness
Copy link
Collaborator Author

Current Status

Ending 2019, while there wasn't too much time to progress on the development, there are some stuff that are already done, in particular, the constructors for our entities:

  • Client (renamed from Entity)
  • Board
  • List
  • Label

(Card couldn't make it before the new decade, sorry 😢)

Commit was renamed to Push, and I also implemented a Pull method, etc.

More info will be given when the card constructor is done and everything is properly tested.

@ddavness
Copy link
Collaborator Author

ddavness commented Jun 3, 2020

Soon:tm:

I'm currently in exam season + my laptop is going to be sent for repair so I don't have much to work with at the moment.

@RonekoKitty
Copy link

no one cares

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
major Work guidelines for a major version release
Projects
None yet
Development

No branches or pull requests

4 participants
@HypheX @ddavness @RonekoKitty and others