|
3 | 3 | This document serves as a guide for contributors implementing new features and resources in the Terraform Provider for GitHub. |
4 | 4 |
|
5 | 5 | - [Architecture Guide](#architecture-guide) |
6 | | - - [Module Map](#module-map) |
7 | | - - [Core Principles](#core-principles) |
8 | | - - [1. One Resource = One API Entity](#1-one-resource--one-api-entity) |
9 | | - - [2. Minimize API Calls](#2-minimize-api-calls) |
10 | | - - [3. API-Only Operations](#3-api-only-operations) |
11 | | - - [Resource Design](#resource-design) |
12 | | - - [File Organization](#file-organization) |
13 | | - - [Resource Structure](#resource-structure) |
14 | | - - [Schema Field Guidelines](#schema-field-guidelines) |
15 | | - - [ID Patterns](#id-patterns) |
16 | | - - [Implementation Patterns](#implementation-patterns) |
17 | | - - [Authentication](#authentication) |
18 | | - - [CRUD Function Signatures](#crud-function-signatures) |
19 | | - - [Accessing the API Client](#accessing-the-api-client) |
20 | | - - [Error Handling](#error-handling) |
21 | | - - [Import](#import) |
22 | | - - [State Migrations](#state-migrations) |
23 | | - - [Logging](#logging) |
24 | | - - [Testing](#testing) |
25 | | - - [Test Structure](#test-structure) |
26 | | - - [Test Modes](#test-modes) |
27 | | - - [Running Tests](#running-tests) |
28 | | - - [Debugging Tests](#debugging-tests) |
29 | | - - [Gotchas \& Known Issues](#gotchas--known-issues) |
30 | | - - [API Preview Headers](#api-preview-headers) |
31 | | - - [Deprecated Resources](#deprecated-resources) |
32 | | - - [Deprecated Data Sources](#deprecated-data-sources) |
33 | | - - [Known Limitations](#known-limitations) |
34 | | - - [Workarounds in Code](#workarounds-in-code) |
35 | | - - [Pending go-github Updates](#pending-go-github-updates) |
36 | | - - [Appendix](#appendix) |
37 | | - - [Common Utilities](#common-utilities) |
38 | | - - [Naming Conventions](#naming-conventions) |
39 | | - - [Decision Log](#decision-log) |
40 | | - - [January 2026](#january-2026) |
41 | | - - [Use StateUpgraders for State Migrations](#use-stateupgraders-for-state-migrations) |
42 | | - - [Explicit Authentication Configuration](#explicit-authentication-configuration) |
43 | | - - [Transport Layer Rework](#transport-layer-rework) |
44 | | - - [Migrate to `terraform-plugin-testing`](#migrate-to-terraform-plugin-testing) |
45 | | - - [No Local Git CLI Support](#no-local-git-cli-support) |
46 | | - - [2025](#2025) |
47 | | - - [Replace `log` Package with `tflog`](#replace-log-package-with-tflog) |
48 | | - - [Finalize SDK v2 Migration](#finalize-sdk-v2-migration) |
| 6 | + - [Module Map](#module-map) |
| 7 | + - [Core Principles](#core-principles) |
| 8 | + - [1. One Resource = One API Entity](#1-one-resource--one-api-entity) |
| 9 | + - [2. Minimize API Calls](#2-minimize-api-calls) |
| 10 | + - [3. API-Only Operations](#3-api-only-operations) |
| 11 | + - [Resource Design](#resource-design) |
| 12 | + - [File Organization](#file-organization) |
| 13 | + - [Resource Structure](#resource-structure) |
| 14 | + - [Schema Field Guidelines](#schema-field-guidelines) |
| 15 | + - [ID Patterns](#id-patterns) |
| 16 | + - [Implementation Patterns](#implementation-patterns) |
| 17 | + - [Authentication](#authentication) |
| 18 | + - [CRUD Function Signatures](#crud-function-signatures) |
| 19 | + - [Accessing the API Client](#accessing-the-api-client) |
| 20 | + - [Error Handling](#error-handling) |
| 21 | + - [Import](#import) |
| 22 | + - [State Migrations](#state-migrations) |
| 23 | + - [Logging](#logging) |
| 24 | + - [Testing](#testing) |
| 25 | + - [Test Structure](#test-structure) |
| 26 | + - [Test Modes](#test-modes) |
| 27 | + - [Running Tests](#running-tests) |
| 28 | + - [Debugging Tests](#debugging-tests) |
| 29 | + - [Gotchas \& Known Issues](#gotchas--known-issues) |
| 30 | + - [API Preview Headers](#api-preview-headers) |
| 31 | + - [Deprecated Resources](#deprecated-resources) |
| 32 | + - [Deprecated Data Sources](#deprecated-data-sources) |
| 33 | + - [Known Limitations](#known-limitations) |
| 34 | + - [Workarounds in Code](#workarounds-in-code) |
| 35 | + - [Pending go-github Updates](#pending-go-github-updates) |
| 36 | + - [Appendix](#appendix) |
| 37 | + - [Common Utilities](#common-utilities) |
| 38 | + - [Naming Conventions](#naming-conventions) |
| 39 | + - [Decision Log](#decision-log) |
| 40 | + - [January 2026](#january-2026) |
| 41 | + - [Use StateUpgraders for State Migrations](#use-stateupgraders-for-state-migrations) |
| 42 | + - [Explicit Authentication Configuration](#explicit-authentication-configuration) |
| 43 | + - [Transport Layer Rework](#transport-layer-rework) |
| 44 | + - [Migrate to `terraform-plugin-testing`](#migrate-to-terraform-plugin-testing) |
| 45 | + - [No Local Git CLI Support](#no-local-git-cli-support) |
| 46 | + - [2025](#2025) |
| 47 | + - [Replace `log` Package with `tflog`](#replace-log-package-with-tflog) |
| 48 | + - [Finalize SDK v2 Migration](#finalize-sdk-v2-migration) |
49 | 49 |
|
50 | 50 | --- |
51 | 51 |
|
|
0 commit comments