Skip to content

Commit 863e2c1

Browse files
committed
docs: add a roadmap to README.md
1 parent bfc177d commit 863e2c1

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,21 @@ I really believe this idea has a lot of good ideas and best practices, however,
99
If you have any interest in this project, please don't hesitate to reach out!
1010
Any advice, support, PR's, etc. are welcome and would be greatly appreciated.
1111

12-
As it stands this project is getting rather close to being ready, but not quite yet. Mainly I want to ensure the github actions pipeline is steady, but once that is done it should be alright for use.
12+
# Roadmap
13+
This is a really brief idea of what is planned for this template, and where it stands currently:
14+
- [x] Swap to UV, Ruff, and Pyright (maybe ty later, but at the moment of writing this isn't ready yet)
15+
- [x] Add cruft and commitizen
16+
- [x] Centralize CI/CD through noxfile using uv cache to maintain speed
17+
- [x] Add CI/CD for GitHub, Gitlab, and Bitbucket (Only GitHub guaranteed to work, but others should be close enough)
18+
- [x] Add automated integration testing with separate repos to act as demos
19+
- [x] Add release process for demo
20+
- [x] Ensure end to end process for base python template works fully
21+
- [] Ensure maturin template works locally
22+
- [] Add modified CI/CD for the maturin version
23+
- [] Add CI/CD for the cookiecutter itself
24+
- [] Add github actions to automate demo publishing on merge to main or develop in cookiecutter
25+
- [] Clean up documentation and make it readable
26+
- [] Possibly swap documentation to follow MADR (Maybe during clean up process, but low priority for the time being)
1327

1428
# Example Output
1529
For an example of this template's output, please visit the [demo](https://github.com/56kyle/robust-python-demo) which is kept up to date with the current state of this template.

0 commit comments

Comments
 (0)