Examples should be compilable
Open
Nobody has claimed this yet.
- Dominant language
- reStructuredText
- Stars
- 497
- Forks
- 41
- Avg merge
- 3h 52m
- Merged PRs (30d)
- 4
Description
Currently, the FLS examples are just random snippets of code, usually illustrating a particular construct. Ideally, all FLS examples should be compilable stand-alone programs that are verified by a tool during building.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the FLS examples and the repository's build process, then identify how examples are currently represented and whether any verification tool is already used. Convert the examples into stand-alone programs and integrate build-time verification; done means the examples compile successfully during the build.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100