Skip to content

Commit

Permalink
Add templates for standardization of files in each WG (chaoss#278)
Browse files Browse the repository at this point in the history
Signed-off-by: Yash Prakash <yash2002109@gmail.com>
  • Loading branch information
yash-yp authored and vchrombie committed Jun 1, 2021
1 parent c3ee07a commit f2084c1
Show file tree
Hide file tree
Showing 3 changed files with 98 additions and 0 deletions.
9 changes: 9 additions & 0 deletions templates/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Contributing to CHAOSS

Thank you for your interest in contributing! 🎉

The general contributing guidelines can be found [here](https://github.com/chaoss/governance/blob/master/CONTRIBUTING.md)

## Specific instructions for this repository

None
84 changes: 84 additions & 0 deletions templates/WG-README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# CHAOSS \<wg-name\> Working Group

Badges (If Any)

## Table of Contents

- [Introduction](#introduction)
- [Participate](#participate)
- [Contributing](#contributing)
- [Metrics](#metrics)
- [Contributors](#contributors)
- [License](#license)

## Introduction

### Goals

A brief description about the goals of the working group.

### Purpose

Answers to why the working group was formed.

### Who should join this working group?

Interests and requirements of the working group.

### Background

- History of the working group
- Name changes in past (if any)
- Any other relevant past information

## Participate

### How to Join Us?

A section guiding the user on how to join the working group.

- Link to the Agenda/Meeting-Minutes document
- Link to the [Participate](https://chaoss.community/participate/) page on the website

Link to [Code of Conduct](https://github.com/chaoss/governance/blob/master/code-of-conduct.md)

## Contributing

See the [CONTRIBUTING.md](CONTRIBUTING.md) for more info.

## Metrics

### Focus-Areas and Goals

Focus Area | Goal
--- | ---
[Focus Area 1](focus-areas/focus-area-1) |
[Focus Area 2](focus-areas/focus-area-2) |
[Focus Area 3](focus-areas/focus-area-3) |
[Focus Area 4](focus-areas/focus-area-4) |

### Released Metrics
A section guiding the user to the released metrics.

- Link to the [metrics](https://chaoss.community/metrics/) page on the website

Link to the [translations](https://github.com/chaoss/translations) repository.

## Contributors

### Chairs

List containing names of contact persons (linked to their Github profiles) for the working group.

-
-

### Amazing CHAOSS Project Contributors

Link to [contributors](https://chaoss.community/metrics/#user-content-chaoss-contributors-include) listed on the website.

## License

See [LICENSE](LICENSE) file.

Copyright © 202X - CHAOSS, a Linux Foundation Project
5 changes: 5 additions & 0 deletions templates/code-of-conduct.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Code of Conduct

Please refer to the [CHAOSS Community Code of Conduct](https://github.com/chaoss/governance/blob/master/code-of-conduct.md)

Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the CHAOSS Code of Conduct Committee via email: <chaoss-inclusion@lists.linuxfoundation.org>

0 comments on commit f2084c1

Please sign in to comment.