ConduitIO / ConduitIO/conduit-site

doc: Add a page for conduit connector developers outlining best practices for writing unit tests

Open
#147 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
MDX
Stars
1
Forks
7
Avg merge
4d 21h
Merged PRs (30d)
2

Description

@nickchomey suggested that our documentation could benefit from a dedicated page on best practices for writing unit tests on Conduit Connectors.

Including an example would be helpful for external contributors, so we should strive to make it as easy as possible for them.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the existing connector documentation structure and its unit-testing guidance in this site, then compare nearby pages for format and examples. Add a dedicated page covering best practices for writing unit tests on Conduit Connectors, including an example that helps external contributors, and verify it builds with the site's documentation.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.