Version 2 Checklist

[drewjbartlett]

Version 2 Checklist

Documentation

• Rewrite version 2 docs to reflect updates
• Rewrite version 2 docs in nuxt (and maybe markdown)
• Add guide for writing tests

Fixes

• allow data with DELETE
• Fix polluted params issue when where params send twice

Enhancements

• api renamed to http
• rename apiConfig to httpConfig
• swap qs for qs-stringify since we only use that method https://www.npmjs.com/package/qs-stringify
• Allow for other promise-based http services to be used in place of axios with injection
• Fix nasty inheritance chain
• Add .default helper to go with model / collection
• Remove spread from request methods (it's not really useful)
• Allow data to be passed into request like photo.get('/tags', { order: orders.ASC })
• Add TypeScript Support while maintaining .js files
• Properly declare and import type definitions Properly declare and import type definitions #41
• Rewrite Auth to be a mixin and extract to package -- rewrite tests for it
• Use deepmerge instead of lodash
• Rename withData to withConfig
• Remove Custom Routes
• Remove interceptors
• Remove qs-stringify with old debugger
• Remove axios entirely
• Remove httpConfig from config
• Remove debug from config
• Add mixins array to allow for creating new methods (auth / base)

Build

• Add build tool to minify or gzip files on dist
• Remove prepublish hook and replace with: Use prepare for build steps and prepublishOnly for upload-only.

Tests

• Extract debugger to allow easier testing
• Write new debugging library (mockid)
• Rewrite tests for CRUD
• Rewrite tests for custom-route
• Rewrite tests for extensions
• Rewrite tests for id
• Rewrite tests for request
• Rewrite tests for request-hooks
• Rewrite tests for routes
• Rewrite tests for with
• Write tests for model, collection, default

I can add a contributing guide for this. But for now:

1. Please run npm run unit:watch while working on new features and fixes. Do you best to make small changes while always keeping the tests green.
2. Only submit small pull requests that are specific to the task. (Horizontal refactoring). If you see something else unrelated that needs fixing, make a ticket or write down a note to address it later

For now we can use issues or projects. @mgred I have not used projects for this but we can look into it!

[drewjbartlett]

@mgred let's use this as a base right now. We can work off developand make small pull requests against it while we are working. How would be best for me to delegate detailed tasks to you?

[ctsstc]

It might be good to use some of the github templating if you would like people to follow contributing guidelines.

https://blog.github.com/2016-02-17-issue-and-pull-request-templates/

[mgred]

@drewjbartlett cool plan.

Only submit small pull requests that are specific to the task

I like that workflow, think its quite efficient to do small but qualitative steps

How would be best for me to delegate detailed tasks to you?

You can give me any task, with a short description in an issue, I think that's enough
BTW, does this list has any priority order?

[drewjbartlett]

@ctsstc @mgred I am down to use issues with templates. Also, there is no priority order on that list at the moment. I have taken on a handful of those tasks at the moment. I will break them up and delegate to you guys if you're down