Skip to main content

GovernanceConfig

Struct GovernanceConfig 

Source
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

Source§

fn clone(&self) -> GovernanceConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GovernanceConfig

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for GovernanceConfig

Source§

fn default() -> GovernanceConfig

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for GovernanceConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for GovernanceConfig

Source§

impl PartialEq for GovernanceConfig

Source§

fn eq(&self, other: &GovernanceConfig) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for GovernanceConfig

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for GovernanceConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts 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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts 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
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more