pub struct GovernanceConfig {
pub adr: Option<PathBuf>,
pub test_strategy: Option<PathBuf>,
pub security: Option<PathBuf>,
pub dod: Option<PathBuf>,
pub constitution: Option<PathBuf>,
pub readme: Option<PathBuf>,
pub docs: Option<PathBuf>,
}Expand description
Governance document paths.
Each field is a pointer to a user-maintained document or directory that describes some aspect of the project’s governance (ADRs, test strategy, security checklist, Definition of Done, project constitution).
All fields are optional and stored as raw PathBuf values. Relative
paths are resolved against the repository root at use time by
downstream consumers, not at config-load time. Absolute paths are
preserved as-is. No filesystem existence check is performed during
config-load — pointing at a path that doesn’t exist is a runtime
concern, not a parse error.
This struct is storage-only: nothing in git_paw::config reads the
referenced documents or enforces any rubric against them. The runtime
consumer lives in the parallel governance-context capability.
Fields§
§adr: Option<PathBuf>Directory containing ADR files. Project chooses the convention
(Nygard, MADR, adr-tools, custom). git-paw does not dictate one.
test_strategy: Option<PathBuf>Single Markdown file describing the project’s test strategy.
security: Option<PathBuf>Single Markdown file containing the project’s security checklist.
dod: Option<PathBuf>Single Markdown file containing the project’s Definition of Done.
constitution: Option<PathBuf>Single Markdown file containing the project’s constitution
(Spec Kit’s constitution.md or any project’s equivalent). May
be auto-populated from .specify/memory/constitution.md when the
SpecKit backend is active and the user has not set this field
explicitly.
readme: Option<PathBuf>Path to the repository README (e.g. README.md). Bring-your-own
pointer surfaced by the MCP documentation tools; None by default,
degrading the get_readme tool to a null result.
docs: Option<PathBuf>Path to the documentation root directory (e.g. docs/src).
Bring-your-own pointer surfaced by the MCP documentation tools
(list_docs/get_doc); None by default, degrading those tools to
empty results.
Trait Implementations§
Source§impl Clone for GovernanceConfig
impl Clone for GovernanceConfig
Source§fn clone(&self) -> GovernanceConfig
fn clone(&self) -> GovernanceConfig
1.0.0 (const: unstable) · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for GovernanceConfig
impl Debug for GovernanceConfig
Source§impl Default for GovernanceConfig
impl Default for GovernanceConfig
Source§fn default() -> GovernanceConfig
fn default() -> GovernanceConfig
Source§impl<'de> Deserialize<'de> for GovernanceConfig
impl<'de> Deserialize<'de> for GovernanceConfig
Source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
impl Eq for GovernanceConfig
Source§impl PartialEq for GovernanceConfig
impl PartialEq for GovernanceConfig
Source§fn eq(&self, other: &GovernanceConfig) -> bool
fn eq(&self, other: &GovernanceConfig) -> bool
self and other values to be equal, and is used by ==.Source§impl Serialize for GovernanceConfig
impl Serialize for GovernanceConfig
impl StructuralPartialEq for GovernanceConfig
Auto Trait Implementations§
impl Freeze for GovernanceConfig
impl RefUnwindSafe for GovernanceConfig
impl Send for GovernanceConfig
impl Sync for GovernanceConfig
impl Unpin for GovernanceConfig
impl UnsafeUnpin for GovernanceConfig
impl UnwindSafe for GovernanceConfig
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,
Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
Source§fn equivalent(&self, key: &K) -> bool
fn equivalent(&self, key: &K) -> bool
key and return true if they are equal.Source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
impl<A, B, T> HttpServerConnExec<A, B> for Twhere
B: Body,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more