From c3bf8a5d25b52633a66ad8721bb6ac5363db95fc Mon Sep 17 00:00:00 2001 From: UnrealApex <79121360+UnrealApex@users.noreply.github.com> Date: Wed, 19 May 2021 15:39:58 -0700 Subject: [PATCH] doc: Added links to folders and headers mentioned (#10111) Closes #10110. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index feb81c5d3..580fc04ed 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -111,13 +111,13 @@ However, some issues/features will require careful thought & formal design befor Specs help collaborators discuss different approaches to solve a problem, describe how the feature will behave, how the feature will impact the user, what happens if something goes wrong, etc. Driving towards agreement in a spec, before any code is written, often results in simpler code, and less wasted effort in the long run. -Specs will be managed in a very similar manner as code contributions so please follow the "Fork, Branch and Create your PR" below. +Specs will be managed in a very similar manner as code contributions so please follow the "[Fork, Branch and Create your PR](CONTRIBUTING.md#fork-clone-branch-and-create-your-pr)" section below. ### Writing / Contributing-to a Spec To write/contribute to a spec: fork, branch and commit via PRs, as you would with any code changes. -Specs are written in markdown, stored under the `\doc\spec` folder and named `[issue id] - [spec description].md`. +Specs are written in markdown, stored under the [`\doc\specs`](./doc/specs) folder and named `[issue id] - [spec description].md`. 👉 **It is important to follow the spec templates and complete the requested information**. The available spec templates will help ensure that specs contain the minimum information & decisions necessary to permit development to begin. In particular, specs require you to confirm that you've already discussed the issue/idea with the team in an issue and that you provide the issue ID for reference.