From c23e0ae434be021193a22aa183f9d2bf212a63c8 Mon Sep 17 00:00:00 2001 From: Mohamed Aziz Mejri Date: Tue, 26 Aug 2025 00:57:13 +0100 Subject: [PATCH] update contributing.md so that it refers to the architecture doc (#1057) This PR adds a reference to the architecture doc in contributing.md . --- ## Summary by cubic Added a link to the Architecture Guide in CONTRIBUTING.md to give contributors a high-level overview and ensure changes align with the project architecture. --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5b3e291..d00d979 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,6 +4,9 @@ Dyad is still a very early-stage project, thus the codebase is rapidly changing. Before opening a pull request, please open an issue and discuss whether the change makes sense in Dyad. Ensuring a cohesive user experience sometimes means we can't include every possible feature or we need to consider the long-term design of how we want to support a feature area. +For a high-level overview of how Dyad works, please see the [Architecture Guide](./docs/architecture.md). Understanding the architecture will help ensure your contributions align with the overall design of the project. + + ## More than code contributions Something that I really appreciate are all the non-code contributions, such as reporting bugs, writing feature requests and participating on [Dyad's sub-reddit](https://www.reddit.com/r/dyadbuilders).