open-feature / open-feature/flagd

[DOC] samples and config/samples duplication

Open
#571 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

contribfest documentation
Dominant language
Go
Stars
997
Forks
136
Avg merge
4d 8h
Merged PRs (30d)
11

Description

Change in the documentation

The repo has both /samples and /config/samples folders both with the same files. However the file contents have diverged.

Which folder is still required (or both)?

If both folders are required, we should bring (and keep) the file contents in sync.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Compare the files in /samples and /config/samples to identify how their contents have diverged. Determine whether one folder is required or both are, then consider the issue done when the repository has a documented folder choice and, if both remain, their contents are synchronized.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.