Skip to content

Add SDK low-effort PR examples document #397

Description

@El-swaggerito

Description

Difficulty: Hard

Type: Documentation

Summary

Document examples of SDK PRs that are unlikely to satisfy evaluation standards.

Current Behaviour

Contributors may not understand why a small merged PR may still be considered insufficient.

Expected Behaviour

The repo should show examples of incomplete, superficial, under-tested, and failing-CI contributions.

Suggested Implementation

Create examples document with improved alternatives and review notes.

Files or Areas Likely Affected

  • docs/
  • README.md

Acceptance Criteria

  • Low-effort PR examples are documented.
  • Under-tested examples are included.
  • Failing-CI examples are included.
  • Improved alternatives are shown.
  • Tone remains constructive.
  • README links to the document.

Additional Notes

This turns the campaign warning into practical guidance.

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked for GrantFox OSS contributionMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial Campaign | FWC26Official GrantFox campaign labeldeveloper-experienceDeveloper experience workdocumentationDocumentation workhardHard difficultysdkSDK related work

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions