Ways To Get Feedback Prioritized

Where To Send Feedback gives tips on good feedback.

Bug reports are prioritized -- this is for improving "vague feedback"

Show Real Code You've Written

Ideally, the code should work and have runnable tests.

Show what the code looks currently, and after the proposed change.

This puts your problem in context.

Familiarize yourself with YSH idioms and concepts

e.g. Interior vs. Exterior

(There is often a simpler "exterior" way to solve a problem -- Oils is exterior-first

Provide a Proof of Concept Implementation

This is the best way to get feedback prioritized, but the highest effort.

You may want to start a discussion before doing this.

Reference Existing Designs

• Other shells
• Python, JS, Ruby
• Perl, PHP
• Lisps
• etc.

Reference Existing Literature

(But summarize the relevant parts)

Be Familiar with how Oils is Implemented

• e.g. a value.Place is a (name, stack frame) tuple, and setValue() must occur in a higher stack frame. It can't occur in a lower one.

Write a Clear, Crisp Document

This might be the last resort, but could help.

Crisp code examples are essential.