Skip to content

Feature Request: Add Example Ruleset Documentation #1

@nonameebyrator985

Description

@nonameebyrator985

Feature Request

It would be beneficial to have example ruleset documentation included in this repository.

Motivation

Providing example rulesets could help new contributors better understand how to format and create rulesets for the legacy code phase of CS156. It would also serve as a reference for best practices and standard conventions in this context.

Suggested Implementation

  • Create a new directory called examples or sample_rulesets
  • Include at least 2-3 example rulesets with descriptions in Markdown format

Benefits

  • Improves onboarding process for new contributors
  • Enhances clarity regarding the ruleset structure and expectations
  • Reduces the chances of incorrect or inconsistent ruleset submissions

Thank you for considering this suggestion!

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions