Skip to content

Commit 4a5f5c0

Browse files
committed
docs: remove old caveat section and place roadmap in expandable block
1 parent 863e2c1 commit 4a5f5c0

File tree

1 file changed

+18
-14
lines changed

1 file changed

+18
-14
lines changed

README.md

Lines changed: 18 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,31 +2,35 @@
22

33
A Python project template robust enough to follow up [cookiecutter-hypermodern-python]
44

5-
# Caveat
5+
# Example Output
6+
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.
67

7-
I really believe this idea has a lot of good ideas and best practices, however, creating it is a ton of work.
8+
## Roadmap
89

9-
If you have any interest in this project, please don't hesitate to reach out!
10-
Any advice, support, PR's, etc. are welcome and would be greatly appreciated.
10+
This is a really brief/condensed idea of what is planned for this template, and where it stands currently:
11+
<details>
12+
<summary>Click to expand</summary>
1113

12-
# Roadmap
13-
This is a really brief idea of what is planned for this template, and where it stands currently:
1414
- [x] Swap to UV, Ruff, and Pyright (maybe ty later, but at the moment of writing this isn't ready yet)
1515
- [x] Add cruft and commitizen
1616
- [x] Centralize CI/CD through noxfile using uv cache to maintain speed
1717
- [x] Add CI/CD for GitHub, Gitlab, and Bitbucket (Only GitHub guaranteed to work, but others should be close enough)
1818
- [x] Add automated integration testing with separate repos to act as demos
1919
- [x] Add release process for demo
2020
- [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)
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+
- [ ] Better define out templates for issues, pull requests, etc.
26+
- [ ] Improve generated changelogs
27+
- [ ] Clean up documentation and make it readable
28+
- [ ] Possibly swap documentation to follow MADR (Maybe during clean up process, but low priority for the time being)
29+
- [ ] Move to an organization (Will be done whenever there are other users besides myself)
30+
- [ ] Add any missing automation for administrative tasks
31+
- [ ] Designate backup plans for the projects lifecycle over time
32+
</details>
2733

28-
# Example Output
29-
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.
3034

3135
# Why does this project exist?
3236

0 commit comments

Comments
 (0)