Skip to content

[Enhancement] Improve inital README.md #1287

@mcm1957

Description

@mcm1957

Please move all developer related information from README.md to a seperated file, named i.e. DEVELOPER.md.

Inital README.md should only contain some templetes to be filled by developer.

A section describing the purpose of the adapter and a dummy link to the manufactorer.
A section stating that the functionality and configuration of the adapter should be described there.
...

Purpose of this suggestion is that a significant number of adapters still have the developer section present within README.md when the adapter is requestd to be reviewed for repositories. If all developer related information is seperated this infomation could be preserved at repository but would not be published. Ina ddition the dev would more clearly see that and what infomation should be added to READEM.md

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