Skip to content

update(template): Adding init command to the Getting Started Section , and also added > to every Note #5

Merged
fivetran-rishabhghosh merged 7 commits into
mainfrom
update/readme-template-improvements
Apr 7, 2026
Merged

update(template): Adding init command to the Getting Started Section , and also added > to every Note #5
fivetran-rishabhghosh merged 7 commits into
mainfrom
update/readme-template-improvements

Conversation

@fivetran-JenasVimal

Copy link
Copy Markdown
Contributor

Closes RD-1188475

Description of Change

  • Add fivetran init command with --template usage, description, and init docs link
  • Add conditional note for configuration.json requirement
  • Convert all Note: entries to > blockquote format per updated style guide

Testing

No Testing

Checklist

Some tips and links to help validate your PR:

  • Tested the connector with fivetran debug command.
  • Added/Updated example-specific README.md file, see the README template for the required structure and guidelines.
  • Followed Python Coding Standards, refer here

… blockquotes

- Add fivetran init command with template usage, description, and init docs link
- Add conditional note for configuration.json requirement
- Convert all Note: entries to > blockquote format per updated style guide

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the Connector SDK README template to reflect the updated style guide and add fivetran init --template guidance for bootstrapping new projects from an existing connector example.

Changes:

  • Added fivetran init command example (with --template) and a link to the init documentation in the Getting started section.
  • Added a conditional note template for connectors that require configuration.json.
  • Converted existing “Note:” callouts to blockquote (> Note:) format.

Comment thread _template_connector/README_template.md
Comment thread _template_connector/README_template.md Outdated
Comment thread _template_connector/README_template.md Outdated
Comment thread _template_connector/README_template.md
Comment thread _template_connector/README_template.md Outdated
```

Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`.
> Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is not requests:latest but it is mentioned here: https://fivetran.com/docs/connector-sdk/technical-reference#preinstalledpackages

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This I will make a change in the other repos as well
Thank you !

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this change yet

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was waiting on your response on the --init command . pushing it now

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done !

Comment thread _template_connector/README_template.md Outdated
```

Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`.
> Note: The `fivetran_connector_sdk:latest` and `requests:latest` packages are pre-installed in the Fivetran environment. To avoid dependency conflicts, do not declare them in your `requirements.txt`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this change yet

Copilot AI review requested due to automatic review settings April 6, 2026 18:14
@github-actions github-actions Bot added size/S and removed size/XS labels Apr 6, 2026
Comment thread _template_connector/README_template.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

Comment thread _template_connector/requirements.txt
Comment thread _template_connector/README_template.md
Comment thread _template_connector/README_template.md
Comment thread _template_connector/README_template.md Outdated
Comment thread _template_connector/requirements.txt
Copilot AI review requested due to automatic review settings April 7, 2026 07:29

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.

@fivetran-rishabhghosh fivetran-rishabhghosh merged commit c28e041 into main Apr 7, 2026
3 checks passed
@fivetran-rishabhghosh fivetran-rishabhghosh deleted the update/readme-template-improvements branch April 7, 2026 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants