Skip to content

Commit

Permalink
Merge pull request #476 from w3c/egekorkan-patch-12
Browse files Browse the repository at this point in the history
Repository readme template
  • Loading branch information
egekorkan committed Feb 21, 2024
2 parents 16d53d8 + 9a0add5 commit 71cf25c
Showing 1 changed file with 97 additions and 0 deletions.
97 changes: 97 additions & 0 deletions README.template.md
@@ -0,0 +1,97 @@
<p align="center">
<a href="https://w3.org/wot">
<img alt="Web of Things Homepage" src="https://www.w3.org/WoT/IG/wiki/images/8/8f/WOT-hz.svg" width="300" />
</a>
</p>

<p align="center">
<a href="https://w3c.social/@wot">
<img alt="Follow on Mastodon" src="https://img.shields.io/mastodon/follow/111609289932468076?domain=https%3A%2F%2Fw3c.social"></a>
<a href="https://twitter.com/W3C_WoT">
<img alt="X (formerly Twitter) Follow" src="https://img.shields.io/twitter/follow/W3C_WoT"></a>
<a href="https://stackoverflow.com/questions/tagged/web-of-things">
<img alt="Stack Exchange questions" src="https://img.shields.io/stackexchange/stackoverflow/t/web-of-things?style=plastic"></a>
</p>

<p align="center">
<a href="https://example.com"> <!-- REC LINK -->
<img alt="Latest REC" src="https://img.shields.io/badge/W3C_REC-Latest-005a9c"></a>
<a href="https://example.com"> <!-- ED LINK -->
<img alt="Latest Editor's Draft" src="https://img.shields.io/badge/Editor's_Draft-Latest-fe914a"></a>
</p>

# Web of Things (WoT) REPO NAME

General information about the Web of Things can be found on https://www.w3.org/WoT/.

---

Introduction about the specification or repo purpose can be put here.

## Logistics

- Call information: We use the W3C Calendar. You can find the next CALL NAME call at https://www.w3.org/groups/wg/wot/calendar.
- Wiki (contains agenda): WIKI LINK
- [Contribution rules](./CONTRIBUTING.md)

## Publications

- [Latest Editor's Draft](github.io link goes here) (syncs to this repository's main branch)
- [Latest Working Draft](w3.org link goes here) (This is relevant for notes and REC-track until publication)
- Recommendations:
- [Version X](https://example.com) - [Repository Snapshot](example https://github.com/w3c/wot-thing-description/tree/REC1.1)
- [Version Y](https://example.com) - [Repository Snapshot](example https://github.com/w3c/wot-thing-description/tree/REC1.1)
- Other deliverables: (Examples are bindings)
- [Example Document A](https://example.com)
- [Example Document B](https://example.com)

---

<!-- The parts below do not apply to all repositories, change them as you see fit but consider them as a guideline -->

## Instructions for Editors and Contributors

If you have followed the [Contribution rules](./CONTRIBUTING.md) and want to contribute, please follow the instructions below.

### Tooling

In repositories like TD and Binding, you should not edit the index.html directly. That is why, please provide instructions for everyone below. An example is given.

When contributing, please use the tooling as explained below:

- Run `npm install`
- Do your contributions to files X, Y, and Z.
- Run `npm render`

If you want to edit figures, their sources are found at X. Please use TOOL A to edit them.

In order to generate the implementation report, the instructions are as follows:

- Instruction 1
- Instruction 2

### Formatting

Example: We use [EditorConfig](https://editorconfig.org/) and [Prettier](https://prettier.io/) to achieve consistency. See the config files in the root of this repository.

## Instructions for Contributing to the Implementation Report

If you have an implementation of this specification, you can submit inputs to help with the generation of the implementation report.
Instructions are as follows:

- Instruction 1
- Instruction 2

## Labeling Conventions

We use the following labels for the purpose written next to them:

- Label A: Purpose

## Known Implementations

The W3C WoT collects known implementations at <https://www.w3.org/WoT/developers/>. Implementations of REPO NAME are found under categories X, Y and Z.

## Further Information

Repository custom content goes here. Please change the title or add more titles below as you see fit.

0 comments on commit 71cf25c

Please sign in to comment.