SSWConsulting / SSWConsulting/SSW.Rules

✨ Architecture - Improve JSON Mapping File Process

Open
#1,780 4 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

YakShaver
Dominant language
TypeScript
Stars
26
Forks
17
Avg merge
14h 39m
Merged PRs (30d)
2

Description

Requested by: @wicksipedia via YakShaver.ai 🦬
cc: @wicksipedia, @christianmorfordwaitessw, @PothieuG, @adamcogan, @JackDevAU, @ncn-ssw, @kulesy, @Ben0189, @isaaclombardssw, @BrookJeynes, @Calinator444, @Marxoz, @Levijj22, @sethdaily

Hi Team!

  🟥  Watch the video (3 min 28 sec)

  Url from screen share: https://github.com/SSWConsulting/SSW.Rules/issues/1756

Pain

Enhance the process of handling JSON mapping files in the Rules V3 project by leveraging TinaCMS's reference fields to avoid manual copying and improve clarity in issue documentation.

Acceptance Criteria
  1. The JSON mapping file process is streamlined using TinaCMS's reference fields.
  2. Documentation is updated to clearly explain the process without needing to reference other issues.
  3. A checklist is added to issues to ensure clarity and completeness.
  4. Acceptance criteria are explicitly stated in each issue.
Screenshot

Screenshot
Figure: Confusion over JSON file creation using Python script without leveraging Tina.io.

Contributor guide

No contributing guide indexed for this repository

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

Review issue 1756, the linked screen-share video, and the current JSON mapping workflow described in this issue. Start by tracing how TinaCMS reference fields relate to the existing Python script and Rules V3 process. Done means the mapping workflow is streamlined, documentation stands alone, and issues include a completeness checklist with explicit acceptance criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
nextjs, python, typescript
Domain
documentation, tooling
Issue type
Feature
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.