Skip to content

Commit

Permalink
Merge pull request #10 from cncf-tags/add-docs
Browse files Browse the repository at this point in the history
Add WG info to Readme
  • Loading branch information
leonardpahlke authored Dec 6, 2023
2 parents 86e9631 + e18ed78 commit bb748b2
Showing 1 changed file with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,26 @@
# WG Green Reviews
# CNCF Green Reviews WG

Project Repository for the WG Green Reviews which is part of the CNCF TAG Environmental Sustainability
The CNCF Green Reviews Working Group (WG) is an open-source, community-led project that is part of the [CNCF Environmental Sustainability Technical Advisory Group (TAG ENV)](https://github.com/cncf/tag-env-sustainability).

The aim of the Green Reviews WG is to set up infrastructure to measure the sustainability footprint of [CNCF Projects](https://www.cncf.io/projects/).

## Community

### Getting Started
Here are some resources to learn about the project:
- **Charter**: The [Green Reviews WG Charter](https://github.com/cncf/tag-env-sustainability/blob/main/working-groups/green-reviews/charter.md) outlines the WG's motivation, scope, goals, non-goals, and deliverables.
- **Design Document**: The [WG's design document](https://docs.google.com/document/d/19fzZW-IMv2kDNatKFHeHh7wqcEN0e2N60wzxvCGZd48/edit?usp=sharing) is a live document created and maintained by the open-source contributors of the WG. Everyone is welcome to contribute ideas, questions, comments, suggestions, and take ownership of the project's implementation.

### Contributing
All contributions are welcome, including code contributions, issues, suggestions, questions, product direction, collaborations, etc.

Some suggestions for how to get involved with the Green Reviews WG:

- Join the twice monthly [WG meetings](https://github.com/cncf/tag-env-sustainability/tree/main/working-groups/green-reviews#meetings-and-contact).
- Discuss asynchronously in [issues](https://github.com/orgs/cncf/projects/10/views/12).
- Post in the CNCF Slack channel [#wg-green-reviews](https://cloud-native.slack.com/archives/C060EDHN431)
- Find an issue in the [WG GitHub board](https://github.com/orgs/cncf/projects/10/views/12).
- Create an issue in the [WG repository](https://github.com/cncf-tags/green-reviews-tooling).
- Feel free to reach out to the [Green Review WG leads](https://github.com/cncf/tag-env-sustainability/tree/main/working-groups/green-reviews#chairs) directly with any queries, preferably in one of the open/public channels listed above.

We encourage all communication to remain public by going through the communications channels listed above so that everyone can stay informed!

0 comments on commit bb748b2

Please sign in to comment.