diff options
| author | ST-DDT <[email protected]> | 2022-09-08 17:24:26 +0200 |
|---|---|---|
| committer | GitHub <[email protected]> | 2022-09-08 15:24:26 +0000 |
| commit | 508082cbde088d2834b324c15dd75f326cb896c7 (patch) | |
| tree | 28f1405905e2f1c68223e0dfd24739b5f97cf138 /docs/about/roadmap | |
| parent | f13d13ffdacc38d8d634ae55f01480c809488032 (diff) | |
| download | faker-508082cbde088d2834b324c15dd75f326cb896c7.tar.xz faker-508082cbde088d2834b324c15dd75f326cb896c7.zip | |
docs: publish v8 roadmap (#1330)
Diffstat (limited to 'docs/about/roadmap')
| -rw-r--r-- | docs/about/roadmap/index.md | 17 | ||||
| -rw-r--r-- | docs/about/roadmap/v6.md | 70 | ||||
| -rw-r--r-- | docs/about/roadmap/v7.md | 38 | ||||
| -rw-r--r-- | docs/about/roadmap/v8.md | 35 |
4 files changed, 160 insertions, 0 deletions
diff --git a/docs/about/roadmap/index.md b/docs/about/roadmap/index.md new file mode 100644 index 00000000..8be8ee4d --- /dev/null +++ b/docs/about/roadmap/index.md @@ -0,0 +1,17 @@ +--- +editLink: false +--- + +# Roadmap + +These pages outline our roadmap for past and future versions. +Click on the specific versions for more details. + +## Upcoming Versions + +- [v8 - Make Faker Handier](v8.html) + +## Previous Versions + +- [v7 - Cleanup & Improvements](v7.html) +- [v6 - Continue Faker](v6.html) diff --git a/docs/about/roadmap/v6.md b/docs/about/roadmap/v6.md new file mode 100644 index 00000000..049c86ac --- /dev/null +++ b/docs/about/roadmap/v6.md @@ -0,0 +1,70 @@ +--- +editLink: false +--- + +# v6 - Continue Faker + +The main task of v6 is fixing technical debts and some cleanup. + +## v6.0 - Ensure project foundation + +- Rewrite project in TypeScript +- Update dependencies and automate the process +- Add/Extend build pipeline +- Write JSDocs for most of the modules and methods +- Add online documentation/website + +[v6.0 Tasks](https://github.com/faker-js/faker/milestone/1) + +**Releases** + +- [v6.0.0-alpha.0](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.0) +- [v6.0.0-alpha.2](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.2) +- [v6.0.0-alpha.3](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.3) +- [v6.0.0-alpha.4](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.4) +- [v6.0.0-alpha.5](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.5) +- [v6.0.0-alpha.6](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.6) +- [v6.0.0-alpha.7](https://github.com/faker-js/faker/releases/tag/v6.0.0-alpha.7) +- [v6.0.0-beta.0](https://github.com/faker-js/faker/releases/tag/v6.0.0-beta.0) +- [v6.0.0](https://github.com/faker-js/faker/releases/tag/v6.0.0) + +## v6.1 - First Bugfixes + +- Fix bugs in the implementation and data +- Standardize some method parameters +- Deprecate duplicate methods +- Extend unit tests +- Link missing locales +- Improve documentation + +[v6.1 Tasks](https://github.com/faker-js/faker/milestone/2) + +**Releases** + +- [v6.1.0](https://github.com/faker-js/faker/releases/tag/v6.1.0) +- [v6.1.1](https://github.com/faker-js/faker/releases/tag/v6.1.1) +- [v6.1.2](https://github.com/faker-js/faker/releases/tag/v6.1.2) + +## v6.2 - First New Features + +- Introduce the first new features +- Add/Update some locales +- More cleanup + +[v6.2 Tasks](https://github.com/faker-js/faker/milestone/5) + +**Releases** + +- [v6.2.0](https://github.com/faker-js/faker/releases/tag/v6.2.0) + +## v6.x + +Further improvements + +- [v6.3 Tasks](https://github.com/faker-js/faker/milestone/7) +- [v6.x Tasks](https://github.com/faker-js/faker/milestone/3) + +**Releases** + +- [v6.3.0](https://github.com/faker-js/faker/releases/tag/v6.3.0) +- [v6.3.1](https://github.com/faker-js/faker/releases/tag/v6.3.1) diff --git a/docs/about/roadmap/v7.md b/docs/about/roadmap/v7.md new file mode 100644 index 00000000..59a715e3 --- /dev/null +++ b/docs/about/roadmap/v7.md @@ -0,0 +1,38 @@ +--- +editLink: false +--- + +# v7 - Cleanup & Improvements + +In v7 we will remove some methods that we have deprecated in v6 and restructure the sources a bit. +It will be the first release with small breaking changes since we maintain it. + +## v7.0 - Structurally Breaking Changes + +- Remove deprecations +- Remove faker default export +- Target es2020 +- Drop Node v12 support +- Reorganize source folder +- More features + +[v7.0 Tasks](https://github.com/faker-js/faker/milestone/8) + +**Releases** + +- [v7.0.0](https://github.com/faker-js/faker/releases/tag/v7.0.0) +- [v7.0.1](https://github.com/faker-js/faker/releases/tag/v7.0.1) + +## v7.x + +Further improvements + +- [v7.x Tasks](https://github.com/faker-js/faker/milestone/4) + +**Releases** + +- [v7.1.0](https://github.com/faker-js/faker/releases/tag/v7.1.0) +- [v7.2.0](https://github.com/faker-js/faker/releases/tag/v7.2.0) +- [v7.3.0](https://github.com/faker-js/faker/releases/tag/v7.3.0) +- [v7.4.0](https://github.com/faker-js/faker/releases/tag/v7.4.0) +- [v7.5.0](https://github.com/faker-js/faker/releases/tag/v7.5.0) diff --git a/docs/about/roadmap/v8.md b/docs/about/roadmap/v8.md new file mode 100644 index 00000000..c43266df --- /dev/null +++ b/docs/about/roadmap/v8.md @@ -0,0 +1,35 @@ +--- +editLink: false +--- + +# v8 - Make Faker Handier + +Our main goal in v8 is to make Faker more lightweight and more flexible. + +## v8.0 - Module Re-Shuffling + +Finish the module shuffling. + +- Remove locale switching support +- Move String and Number methods into own modules +- Rename Name module to Person +- Rename Address module to Location +- Check modules and methods regarding their name and location +- Try to eliminate circular dependencies in modules +- Standardize function parameters and defaults +- Rewrite image module / providers + +[v8.0 Tasks](https://github.com/faker-js/faker/milestone/10) + +## v8.1 - Split Faker Class + +Split the Faker class into smaller units so you don't have ship an entire locale if you only generate some strings and numbers. + +[v8.1 Tasks](https://github.com/faker-js/faker/milestone/11) + +## v8.x - Tree-Shakeable Module-Functions + +Refactor modules to be tree shakeable. +Potentially allowing individual Faker methods to be called by themselves. + +[v8.x Tasks](https://github.com/faker-js/faker/milestone/12) |
