Skip to content

Commit c315d76

Browse files
committed
docs: add roadmap
1 parent 03aeefc commit c315d76

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525
* [Shared configuration](#shared-configuration)
2626
* [API](#api)
2727
* [Tools](#tools)
28+
* [Roadmap](#roadmap)
2829
* [Version Support](#version-support)
2930
* [Related projects](#related-projects)
3031
* [License](#license)
@@ -99,6 +100,23 @@ A number of shared configurations are available to install and use with `commitl
99100
* [commitizen adapter](./@commitlint/prompt)
100101
* [prompt](./@commitlint/prompt-cli)
101102

103+
## Roadmap
104+
105+
> **Ideas**: [marionebl/commitlint#94](https://github.com/marionebl/commitlint/issues/94)
106+
107+
`commitlint` is considered stable and is used in various projects as development tool.
108+
109+
We indentify **ease of adoption** and **developer experience** as fields where there
110+
is room and need for improvement. The items on the roadmap should enhance `commitlint` regarding those aspects.
111+
112+
* [x] **Adoption** Provide reusable Travis CI integration: `@commitlint/travis-cli` (https://github.com/marionebl/commitlint/releases/tag/v5.1.0)
113+
* [ ] **DX** Support PR squash scenario via [ahmed-taj/commitlint-bot](https://github.com/ahmed-taj/commitlint-bot/) and `@commitlint/travis-cli`
114+
* [ ] **Adoption** Make [ahmed-taj/commitlint-bot](https://github.com/ahmed-taj/commitlint-bot/) configurable via `commitlint` configuration
115+
* [ ] **Adoption** Create `commitlint init`
116+
* [ ] **DX**: Extend the configuration schema to allow for additional fields (descriptions, examples, fixes) on both the rule and value level
117+
* [ ] **DX**: Incorporate an extended version of [lennym/commit-template](https://github.com/lennym/commit-template) deducing a template from commitlint configuration
118+
* [ ] **DX**: Rewrite `@commitlint/prompt` for better usability (might involve a lot of yak-shaving)
119+
102120
## Version Support
103121

104122
* Node.js [LTS](https://github.com/nodejs/LTS#lts-schedule) `>= 4.8`

0 commit comments

Comments
 (0)