Skip to content

Commit 67cb878

Browse files
committed
Roadmap Added
Added a roadmap for this repository
1 parent a4a0e8c commit 67cb878

2 files changed

Lines changed: 33 additions & 0 deletions

File tree

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -136,3 +136,16 @@ pytest tests/
136136
```
137137

138138
All tests use dummy data and run without requiring field inputs.
139+
140+
---
141+
142+
## 🛣️ Roadmap
143+
144+
We’re actively improving this repository. Here are planned features:
145+
146+
- Add `examples/` folder with completed outputs
147+
- Launch GitHub Pages docs site for walkthroughs
148+
- Design a visual banner/logo
149+
- Improve interactivity of notebooks
150+
- Add versioned releases and changelogs
151+
- Write a contributor guide for open collaboration

ROADMAP.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## 🛣️ Roadmap
2+
3+
This repository is live and fully usable — but here’s what’s next on the roadmap:
4+
5+
### 📘 Short-Term Enhancements
6+
- [ ] **Add `examples/` folder** with filled notebooks and screenshots of outputs
7+
- [ ] **Improve notebook interactivity** with widgets and dropdown filters
8+
- [ ] **Tag additional use cases** in `use_cases.md` (e.g., time series, dashboard design)
9+
10+
### 🌐 Mid-Term
11+
- [ ] **Launch GitHub Pages or mini-site** for documentation and notebook walkthroughs
12+
- [ ] **Embed Colab output previews** with screenshots or nbviewer links
13+
14+
### 🎨 Visual and Usability
15+
- [ ] **Add a banner/logo** to give the repo a visual identity
16+
- [ ] **Create a contributor guide** to help others fork, test, and contribute
17+
18+
### 📦 Tooling and Ecosystem
19+
- [ ] **Integrate code coverage reports** (e.g., with `codecov`)
20+
- [ ] **Add versioning to releases** via GitHub tags and changelogs

0 commit comments

Comments
 (0)