microsoft/restler-fuzzer

add sample config at the start of CompilerConfig.md

Open

#456 opened on Feb 2, 2022

View on GitHub
 (0 comments) (0 reactions) (1 assignee)Python (329 forks)auto 404
documentationhelp wanted

Repository metrics

Stars
 (2,929 stars)
PR merge metrics
 (PR metrics pending)

Description

Add an overview paragraph with:

  • a small example with the minimal required parameters
  • a message directing users to run 'Compile' with --api_spec to produce a sample config with all the latest options.

Contributor guide

Research direction
Read the existing CompilerConfig.md file, then run the Compile command with api spec to generate a sample configuration. Identify the minimal required parameters and add an example at the beginning of the file.
Tech stack
pythonrest api
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85