SliceCraft / SliceCraft/MiSideSpeedrunMod

Document Trigger Reveal system

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

Nobody has claimed this yet.

documentation good first issue
Dominant language
C#
Stars
4
Forks
2
Avg merge
12m
Merged PRs (30d)
1

Description

This is just an issue to add a markdown document outlining the different colors of triggers, examples of each and what they do.
It will be inside /RevealSystem and be called something like RevealSystemHelp or something.

I will work on this later, after I finish work on the labeling system for the trigger reveal system, but if anyone come's in before that, this is a good first issue.

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 in the /RevealSystem directory and inspect the trigger reveal implementation to identify the trigger colors and their behavior. Add a Markdown document there, using a descriptive filename, with examples and explanations for each color; done means the document covers the available triggers clearly.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.