Unified Readme across WoT repositories

[egekorkan]

This comes from w3c/wot-discovery#333 . I think we should synchronize how Readmes look like across WoT Readmes.

[relu91]

Kind of related to #190 😃

[egekorkan]

Call of 05.07:

• We should create one and populate it to the other ones, as a template. This should be a repo with a deliverable (i.e. not marketing).
• The information that should be contained:
  • Editor's draft and published version(s)
  • Implementation reports
  • Intro paragraph
  • Pointer to the web page
• This needs to be mentioned in the main call since it involves the WG work. We should not go and replace the readmes of TF repos.

[egekorkan]

Adding some other items that should be in the readmes after going through what each spec repo is doing:

• Publications should be
  • Latest Editor's Draft (github.io)
  • Latest WD of the ongoing specification.
  • REC publications: every version beforehand, branches that correspond to the recs
  • In repositories with multiple deliverables underneath (like binding templates and maybe profile in the future), links to the individual pages
• Linking to the agenda and its wiki
• Link to the meeting (maybe just linking to the w3c calendar or our calendar page)
• Instructions for contributors:
  • How to contribute in general (PR etc.) and possibly link to IPR policy etc.
  • How to use spec generation pipeline: This is more relevant for binding templates and TD. Other repositories do not use it at the moment.
  • How to edit the figures. There are different tools used such as draw.io, PowerPoint, plantuml
• Explaining how to contribute to the implementation report (relevant for implementors)
• Explaining how to render the implementation report (relevant for editors)
• Pointer to Twitter, Stack Overflow
• Editor conventions (like editorconfig usage or simply explaining the tabs, spaces, etc.)
• Explaining the usage of labels
• Links for tools for editors
• (seen only in scripting) A rationale document link
• (seen only in discovery but makes sense overall): Links to implementations, use cases, requirements
• (seen only in profile): Giving motivation in the introduction paragraph

[egekorkan]

Call of 27.09:

• W3C also provides information on this at https://w3c.github.io/ . This should be read first

[egekorkan]

Call of 27.09:

* W3C also provides information on this at https://w3c.github.io/ . This should be read first

@ashimura I have read this but there is no guideline about how readmes should look like.