git-captains-log 0.7.1__tar.gz → 0.7.2__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/PKG-INFO +1 -1
- git_captains_log-0.7.2/docs/README.md +34 -0
- git_captains_log-0.7.2/docs/ideas/README.md +24 -0
- git_captains_log-0.7.2/docs/roadmap/README.md +15 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/pyproject.toml +1 -3
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/_version.py +2 -2
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/cli.py +5 -10
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/.gitignore +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/LICENSE +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/README.md +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/__init__.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/app.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/btw.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/cli_logging.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/config/__init__.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/config/config_loader.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/config/config_models.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/entries/__init__.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/entries/entry_formatter.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/entries/entry_models.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/entries/entry_processor.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/git/__init__.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/git/commit_parser.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/git/git_operations.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2/src/hooks}/commit-msg +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2/src/hooks}/commit-msg-package +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/logs/__init__.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/logs/log_manager.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/logs/log_models.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/logs/log_parser.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/logs/log_writer.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/projects/__init__.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/projects/project_finder.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/projects/project_models.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/shortcuts.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/stone.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/update_log.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/wnext.py +0 -0
- {git_captains_log-0.7.1 → git_captains_log-0.7.2}/src/wtf.py +0 -0
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# Documentation Map
|
|
2
|
+
|
|
3
|
+
This repository uses a docs-as-code layout bootstrapped by [adrlane](https://github.com/koradon/adrlane).
|
|
4
|
+
|
|
5
|
+
## Structure
|
|
6
|
+
|
|
7
|
+
| Path | Purpose |
|
|
8
|
+
| --- | --- |
|
|
9
|
+
| `docs/specs/` | Feature specifications, behavior, and contracts |
|
|
10
|
+
| `docs/plans/` | Implementation plans derived from specs |
|
|
11
|
+
| `docs/adr/` | Architecture and design decision records |
|
|
12
|
+
| `docs/ideas/` | Early concepts that may be promoted to specs |
|
|
13
|
+
| `docs/roadmap/` | Now / Next / Later horizons for future initiatives |
|
|
14
|
+
| `docs/llm/` | Agent-facing documentation contract and templates |
|
|
15
|
+
|
|
16
|
+
## How this documentation grows
|
|
17
|
+
|
|
18
|
+
`adrlane init` creates a minimal core and does not predict future project shape.
|
|
19
|
+
|
|
20
|
+
When the project gains a new, recurring documentation need (for example CLI reference, runbooks, or API reference), the agent should:
|
|
21
|
+
|
|
22
|
+
1. Add a new top-level folder under `docs/` when the content does not fit `specs/`, `plans/`, `adr/`, `ideas/`, or `roadmap/`.
|
|
23
|
+
2. Copy a starter template from `docs/llm/templates/` and adapt it.
|
|
24
|
+
3. Update this file to document the new section.
|
|
25
|
+
|
|
26
|
+
Do not create empty folders "for later". Grow the tree only when there is real content to place there.
|
|
27
|
+
|
|
28
|
+
Release history lives in Git and release tooling, not in `docs/`.
|
|
29
|
+
|
|
30
|
+
For the full growth model, see the [adrlane documentation model](https://github.com/koradon/adrlane#documentation-model).
|
|
31
|
+
|
|
32
|
+
## For agents
|
|
33
|
+
|
|
34
|
+
Read `docs/llm/AGENT_PROTOCOL.md` first. It defines the doc workflow (`idea -> spec -> plan`) and how to extend the documentation consistently.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Ideas
|
|
2
|
+
|
|
3
|
+
Ideas are early, uncommitted concepts. The goal is to decide whether a concept deserves further investment.
|
|
4
|
+
|
|
5
|
+
An idea can flow into:
|
|
6
|
+
|
|
7
|
+
- a **Spec** (`docs/specs/`) when the desired behavior and contracts become clear
|
|
8
|
+
- a **Plan** (`docs/plans/`) when implementation needs multiple steps or sessions
|
|
9
|
+
|
|
10
|
+
If an idea does not pass evaluation, the agent may set `## Status` to `rejected` (and optionally link what was decided instead).
|
|
11
|
+
|
|
12
|
+
## Common flow
|
|
13
|
+
|
|
14
|
+
1. Create/update an idea in `docs/ideas/`.
|
|
15
|
+
2. When the behavior is clear enough, create a spec in `docs/specs/` and link them in `## Related`.
|
|
16
|
+
3. When implementation is non-trivial, create a plan in `docs/plans/` and link it from the spec.
|
|
17
|
+
|
|
18
|
+
## Template
|
|
19
|
+
|
|
20
|
+
Copy and adapt `docs/llm/templates/idea.md`.
|
|
21
|
+
|
|
22
|
+
## How to stay agnostic
|
|
23
|
+
|
|
24
|
+
Ideas describe outcomes and constraints without assuming a specific stack (web, backend, CLI, or binaries).
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Roadmap (Now / Next / Later)
|
|
2
|
+
|
|
3
|
+
The roadmap holds future initiatives without committing to exact dates.
|
|
4
|
+
|
|
5
|
+
- **Now**: active work or work starting soon (high confidence)
|
|
6
|
+
- **Next**: upcoming work with high confidence, but not started yet
|
|
7
|
+
- **Later**: speculative bets or ideas pending further validation
|
|
8
|
+
|
|
9
|
+
### Update semantics
|
|
10
|
+
|
|
11
|
+
- Add items when there is enough clarity to evaluate them.
|
|
12
|
+
- Link roadmap items to the related **Idea**, **Spec**, and/or **Plan** documents.
|
|
13
|
+
- Move items between horizons when confidence changes.
|
|
14
|
+
|
|
15
|
+
If the project needs more detailed horizon pages, the agent can add them under `docs/roadmap/` using `docs/llm/templates/roadmap.md`.
|
|
@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "git-captains-log"
|
|
7
|
-
version = "0.7.
|
|
7
|
+
version = "0.7.2"
|
|
8
8
|
# dynamic = ["version"] # Temporarily disabled for release
|
|
9
9
|
description = "Automatically aggregate git commit messages daily into markdown logs"
|
|
10
10
|
authors = [
|
|
@@ -36,8 +36,6 @@ packages = ["src"]
|
|
|
36
36
|
[tool.hatch.build.targets.sdist]
|
|
37
37
|
include = [
|
|
38
38
|
"src/",
|
|
39
|
-
"commit-msg",
|
|
40
|
-
"commit-msg-package",
|
|
41
39
|
"README.md",
|
|
42
40
|
"LICENSE",
|
|
43
41
|
]
|
|
@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
|
|
|
18
18
|
commit_id: str | None
|
|
19
19
|
__commit_id__: str | None
|
|
20
20
|
|
|
21
|
-
__version__ = version = '0.7.
|
|
22
|
-
__version_tuple__ = version_tuple = (0, 7,
|
|
21
|
+
__version__ = version = '0.7.2'
|
|
22
|
+
__version_tuple__ = version_tuple = (0, 7, 2)
|
|
23
23
|
|
|
24
24
|
__commit_id__ = commit_id = None
|
|
@@ -75,17 +75,12 @@ def setup():
|
|
|
75
75
|
# Install commit-msg hook
|
|
76
76
|
print("Installing Git commit-msg hook...")
|
|
77
77
|
|
|
78
|
-
#
|
|
79
|
-
|
|
78
|
+
# Hook templates ship inside the package (src/hooks/), so this works the
|
|
79
|
+
# same way for an editable/source install and a real wheel install.
|
|
80
|
+
hooks_dir = package_dir / "hooks"
|
|
81
|
+
commit_msg_source = hooks_dir / "commit-msg-package"
|
|
80
82
|
if not commit_msg_source.exists():
|
|
81
|
-
|
|
82
|
-
commit_msg_source = package_dir.parent / "commit-msg"
|
|
83
|
-
if not commit_msg_source.exists():
|
|
84
|
-
# Try alternate location (when installed from wheel)
|
|
85
|
-
commit_msg_source = Path(__file__).parent.parent / "commit-msg-package"
|
|
86
|
-
if not commit_msg_source.exists():
|
|
87
|
-
# Final fallback
|
|
88
|
-
commit_msg_source = Path(__file__).parent.parent / "commit-msg"
|
|
83
|
+
commit_msg_source = hooks_dir / "commit-msg"
|
|
89
84
|
|
|
90
85
|
commit_msg_dest = git_hooks_dir / "commit-msg"
|
|
91
86
|
if commit_msg_source.exists():
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|