SSWConsulting / SSWConsulting/SSW.Rules

Rule content editing process to be faster and more independent for major editors

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

Nobody has claimed this yet.

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

Description

Hi team,

as per my conversation with @bradystroud and Uly (can't @mention Uly 🙁 )

  • I expect a lot of rule changes to be just fixing typos, grammar, or simply improving a sentence...
  • Also... quite often we need urgent new rules or rule changes (e.g. Adam needs them for a presentation or a video recording)

We should be able to make these simple or urgent internal changes easier... without requiring reviews, approvals, merging, then waiting for the final release.

--

  1. Can we create a nice workflow diagram, showing the current step-by-step details for editing a rule? (Including technical GitHub limitations)

  2. Then discuss and propose ways to make this workflow simpler?

    • This would be set specifically for major content editors - like Tiago, Uly, Adam... which will have certain permissions.
    • External people and new employees should still wait for approvals, so we need different workflows for each role

AB#60375

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

Start with the current GitHub rule-editing process described by the issue and the linked AB#60375 work item; document each step and its technical limitations. Done means a workflow diagram and a concrete proposal for separate major-editor versus approval-based paths, with the relevant permissions and release wait documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.