integrated-application-development / integrated-application-development/delphilint

Include readme and installation instructions into release

Open
#92 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Pascal
Stars
146
Forks
31
PR merge metrics
No merged PRs in 30d

Description

### Prerequisites

- [x] This improvement has not already been suggested.
- [x] This improvement would be generally useful, not specific to my code or setup.
- [x] This improvement is not related to analysis quality (e.g. new rules, improvements to existing rules), which should be raised on the [SonarDelphi repository](https://github.com/integrated-application-development/sonar-delphi/issues).

### Engine area

Other

### Improvement description

Add readme and installation instructions.

### Rationale

Currently the package contains just 4 files, it's hard to tell what's the app, its source, author, how to install it, etc..

Image

Contributor guide

Open the contributing guide

Research direction

The issue mentions a package containing four files but names none; inspect those files and the repository's release layout first. Document what the app is, its source and author, and how to install it in a README, then verify the README and installation instructions are included in the release package.

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
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.