Skip to content

Commit 88117da

Browse files
feature(connector_sdk): Rename template_connector (#2)
* feature(connector_sdk): Rename template_connector * fix: Update template file references to README_template.md
1 parent cbba5c7 commit 88117da

8 files changed

Lines changed: 5 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ Every new connector example contribution must include proper documentation:
147147

148148
#### README.md
149149

150-
Each new connector example must include a `README.md` file in its directory. Refer to the [template connector](https://github.com/fivetran/fivetran-csdk-connectors/tree/main/template_connector) for structure and formatting.
150+
Each new connector example must include a `README.md` file in its directory. Refer to the [template connector](https://github.com/fivetran/fivetran-csdk-connectors/tree/main/_template_connector) for structure and formatting.
151151

152152
#### Root README.md update
153153

FIVETRAN_CODING_PRINCIPLES.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,11 +74,11 @@ To adhere to Fivetran engineering standards, follow this process:
7474
### 4.1 Template connector
7575
7676
A reference implementation is available here:
77-
[Fivetran Connector SDK Template Example](https://github.com/fivetran/fivetran-csdk-connectors/tree/main/template_connector)
77+
[Fivetran Connector SDK Template Example](https://github.com/fivetran/fivetran-csdk-connectors/tree/main/_template_connector)
7878
7979
This includes:
8080
- A `connector.py` template.
81-
- A `README.md` template illustrating recommended structure and conventions.
81+
- A `README_template.md` file illustrating recommended structure and conventions.
8282
8383
This is a great place to start to learn our coding practices through templated examples.
8484

PYTHON_CODING_STANDARDS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -468,6 +468,6 @@ __BASE_DELAY = 1 # Base delay in seconds for API request retries
468468

469469
## Templates
470470

471-
Refer to our `connector.py` template and `README.md` template in this repo ([https://github.com/fivetran/fivetran-csdk-connectors/tree/main/template_connector](https://github.com/fivetran/fivetran-csdk-connectors/tree/main/template_connector)).
471+
Refer to our `connector.py` and `README_template.md` files in this repo ([https://github.com/fivetran/fivetran-csdk-connectors/tree/main/_template_connector](https://github.com/fivetran/fivetran-csdk-connectors/tree/main/_template_connector)).
472472

473473
It contains some ideas about structuring your code. Review it to get a general understanding of our example format.

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ These are ready-to-use connectors, requiring minimal modifications to get starte
173173

174174
## Documentation & Resources
175175

176-
- **[template_connector](template_connector)** - Reference template for building new connectors
176+
- **[_template_connector](_template_connector)** - Reference template for building new connectors
177177
- **[CONTRIBUTING.md](CONTRIBUTING.md)** - Guide for contributing to this repository
178178
- **[PYTHON_CODING_STANDARDS.md](PYTHON_CODING_STANDARDS.md)** - Python coding standards and best practices
179179
- **[FIVETRAN_CODING_PRINCIPLES.md](FIVETRAN_CODING_PRINCIPLES.md)** - Code review principles and PR guidelines

0 commit comments

Comments
 (0)