Skip to content
This repository was archived by the owner on Aug 21, 2025. It is now read-only.

Suggested edits for clarity based on suggestions from the Grammarly tool. #43

Open
wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

Suggested edits for clarity based on suggestions from the Grammarly tool. #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a46e08
Suggested edits for clarity based on suggestions from the Grammarly t…
JohanForngren Sep 18, 2024
0fd27f9
DCO Remediation Commit for Johan Forngren <johan.forngren@decerno.se>
JohanForngren Sep 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 23 additions & 23 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,43 +3,43 @@

First off, thanks for taking the time to contribute! ❤️

All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉
All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it much easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉

> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> And if you like the project but don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about:
> - Star the project
> - Tweet about it
> - Refer this project in your project's readme
> - Refer to this project in your project's readme
> - Mention the project at local meetups and tell your friends/colleagues

<!-- omit in toc -->
## Table of Contents

- [I Have a Question](#i-have-a-question)
- [I Want To Contribute](#i-want-to-contribute)
- [Reporting Bugs](#reporting-bugs)
- [Suggesting Enhancements](#suggesting-enhancements)
  - [Reporting Bugs](#reporting-bugs)
  - [Suggesting Enhancements](#suggesting-enhancements)
- [Editing Content](#editing-content)
- [Developing Locally](#developing-locally)
- [Join The Project Team](#join-the-project-team)

## I Have a Question

> If you want to ask a question, we assume that you have read the available [Documentation](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/82214913/Community+Green+Maturity+Matrix).
> If you want to ask a question, we assume that you have read the available [documentation](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/82214913/Community+Green+Maturity+Matrix).

Before you ask a question, it is best to search for existing [Issues](https://github.com/Green-Software-Foundation/green-software-maturity-matrix/issues) that might help you. In case you have found a suitable issue and still need clarification, you can write your question in this issue. It is also advisable to search the internet for answers first.
Before you ask a question, it is best to search for existing [Issues](https://github.com/Green-Software-Foundation/green-software-maturity-matrix/issues) that might help you. If you have found a suitable issue and still need clarification, you can write your question about this issue. It is also advisable to search the internet for answers first.

If you then still feel the need to ask a question and need clarification, we recommend the following:

- Open an [Issue](https://github.com/Green-Software-Foundation/green-software-maturity-matrix/issues/new).
- Provide as much context as you can about what you're running into.
- Provide project and platform versions (nodejs, npm, etc), depending on what seems relevant.
- Provide as much context as possible about what you're running into.
- Provide project and platform versions (Node.js, npm, etc), depending on what seems relevant.

We will then take care of the issue as soon as possible.

<!--
You might want to create a separate issue tag for questions and include it in this description. People should then tag their issues accordingly.

Depending on how large the project is, you may want to outsource the questioning, e.g. to Stack Overflow or Gitter. You may add additional contact and information possibilities:
Depending on the project's size, you may want to outsource the questioning, e.g., to Stack Overflow or Gitter. You may add additional contact and information possibilities:
- IRC
- Slack
- Gitter
Expand All @@ -54,52 +54,52 @@ Depending on how large the project is, you may want to outsource the questioning
## I Want To Contribute

> ### Legal Notice <!-- omit in toc -->
> When contributing to this project, you must agree that you have authored 100% of the content, that you have the necessary rights to the content and that the content you contribute may be provided under the project license.
> When contributing to this project, you must agree that you have authored 100% of the content, you have the necessary rights to the content, and that the content you contribute may be provided under the project license.

### Suggesting Enhancements

This section guides you through submitting an enhancement suggestion for Green Software Maturity Matrix, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community to understand your suggestion and find related suggestions.
This section guides you through submitting an enhancement suggestion for Green Software Maturity Matrix, **including completely new features and minor improvements to existing functionality**. Following these guidelines will help maintainers and the community understand your suggestions and find related suggestions.

<!-- omit in toc -->
#### Before Submitting an Enhancement

- Make sure that you are using the latest version.
- Read the [documentation](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/82214913/Community+Green+Maturity+Matrix) carefully and find out if the functionality is already covered, maybe by an individual configuration.
- Perform a [search](https://github.com/Green-Software-Foundation/green-software-maturity-matrix/issues) to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a strong case to convince the project's developers of the merits of this feature. Keep in mind that we want features that will be useful to the majority of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.
- Find out whether your idea fits with the scope and aims of the project. It's up to you to make a solid case to convince the project's developers of the merits of this feature. Remember that we want features that will be useful to most of our users and not just a small subset. If you're just targeting a minority of users, consider writing an add-on/plugin library.

<!-- omit in toc -->
#### How Do I Submit a Good Enhancement Suggestion?

Enhancement suggestions are tracked as [GitHub issues](https://github.com/Green-Software-Foundation/green-software-maturity-matrix/issues).

- Use a **clear and descriptive title** for the issue to identify the suggestion.
- Identify the suggestion by using a **clear and descriptive title** for the issue.
- Provide a **step-by-step description of the suggested enhancement** in as many details as possible.
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point you can also tell which alternatives do not work for you.
- You may want to **include screenshots and animated GIFs** which help you demonstrate the steps or point out the part which the suggestion is related to. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
- **Describe the current behavior** and **explain which behavior you expected to see instead** and why. At this point, you can also tell which alternatives do not work for you.
- You may **include screenshots and animated GIFs** that help you demonstrate the steps or point out the part to which the suggestion is related. You can use [this tool](https://www.cockos.com/licecap/) to record GIFs on macOS and Windows, and [this tool](https://github.com/colinkeenan/silentcast) or [this tool](https://github.com/GNOME/byzanz) on Linux. <!-- this should only be included if the project has a GUI -->
- **Explain why this enhancement would be useful** to most Green Software Maturity Matrix users. You may also want to point out the other projects that solved it better and which could serve as inspiration.

<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide and that defines the structure of the information to be included. If you do so, reference it here in the description. -->
<!-- You might want to create an issue template for enhancement suggestions that can be used as a guide, and that defines the structure of the information to be included. If you do so, reference it here in the description. -->

## Editing Content

This project is a static website based on the project https://docusaurus.io, you can find more information about docusaurus here: https://docusaurus.io/docs
This project is a static website based on the project [docusaurus](https://docusaurus.io). You can find more information about docusaurus here in the [docs](https://docusaurus.io/docs)

The `docs` folder contains all of the material in this project, editing any file there in the `main` branch will update the website. If you are only interested in editing content on the website then you should not need to leave the `docs` folder.
The `docs` folder contains all of the material in this project. Editing any file in the `main` branch will update the website. If you are only interested in editing content on the website, then you should not need to leave the `docs` folder.

The documentation files use a format called markdown and they end in `.md` which supports certain basic styling features like so: https://docusaurus.io/docs/markdown-features
The documentation files use a markdown format, with files ending in `.md`. These files support [certain basic styling features](https://docusaurus.io/docs/markdown-features).

## Developing Locally

To edit this project on your local machine and see the output as it would be rendered on the website you will need `node` at least version 14 installed.
To edit this project on your local machine and see the output as it would be rendered on the website you will need `node` at least version 18 installed.

We also recommend to use `yarn` as the package management solution as the deployment scripts use `yarn` not `npm`.
We also recommend using `yarn` as the package management solution, as the deployment scripts use `yarn` instead of `npm`.

`npm -g install yarn`

`yarn install`

Then to run the project locally type
Then, to run the project locally, type

`yarn run docusaurus start`

Expand Down
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Green Software Maturity Matrix

The Green Software Maturity Matrix is a self-assessment tool. It helps organisations understand the extent to which they have implemented green principles, patterns, and processes for building and operating their software systems.
The Green Software Maturity Matrix is a self-assessment tool. It helps organizations understand the extent to which they have implemented green principles, patterns, and processes for building and operating their software systems.

This project is run through the [Community Working Group](https://grnsft.org/community-wg) in the [Green Software Foundation](https://greensoftware.foundation).

Expand All @@ -18,11 +18,11 @@ The matrix addresses four problems. It answers the questions:

This project entered the Green Software Foundation as a Draft on 27 October 2023.

> **This is a draft document only and has not been approved or adopted by the Green Software Foundation. this draft may not be relied upon for any purpose other than review of the current state of development.**
> **This is a draft document and has not been approved or adopted by the Green Software Foundation. This draft may not be relied upon for any purpose other than to review the current state of development.**

## Appointments

The project is lead by:
The project is led by:

* [Anne Currie](https://github.com/aecurrie)
* [Pini Reznik](https://github.com/pinireznik)
Expand All @@ -31,6 +31,6 @@ The project is lead by:
[Creative Commons Attribution 4.0](https://creativecommons.org/licenses/by/4.0/).

## Contributing
This project is open source and welcomes public contribution via issues, discussions and pull requests.
This project is open source and welcomes public contributions via issues, discussions, and pull requests.

Instructions for how to contribute to this project can be found in the [CONTRIBUTING.md](CONTRIBUTING.md) file.
The [CONTRIBUTING.md](CONTRIBUTING.md) file contains instructions for contributing to this project.
20 changes: 10 additions & 10 deletions SCOPE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@

# Scope

The Green Software Maturity Matrix is a self-assessment tool. It helps organisations understand the extent to which they have implemented green principles, patterns, and processes for building and operating their software systems.
The Green Software Maturity Matrix is a self-assessment tool. It helps organizations understand the extent to which they have implemented green principles, patterns, and processes for building and operating their software systems.

The matrix addresses four problems. It answers the questions:

* **"Where do I start?"** - for enterprises at level 1 of the GSMM, which tools and projects are available to help then achieve level 2
* **"Where do I start?"** - for enterprises at level 1 of the GSMM, which tools and projects are available to help them achieve level 2
* **"Where am I now?"** - by using the checklists of the GSMM, enterprises can establish which level of the GSMM they are currently at for different axes
* **"What am I heading towards?"** - by establishing their current level, they can understand what is a realistic next milestone
* **"How do I know I am making progress?"** - by tracking their progress they can check they are not stuck
* **"How do I know I am making progress?"** - by tracking their progress, they can check they are not stuck


# Target Audience
Expand All @@ -17,11 +17,11 @@ The matrix addresses four problems. It answers the questions:

# Solution

A simple maturity matrix with 5-6 levels of carbon efficiency and awareness in a poster-style diagram, together with a short guide. Training courses including those offered by the GSF, and standards such as the SCI & ISO can be overlaid.
A simple maturity matrix with 5-6 levels of carbon efficiency and awareness in a poster-style diagram, together with a short guide. Training courses, including those offered by the GSF, and standards such as the SCI & ISO can be overlaid.

# Objectives
* Get all GSF Members to start reporting (at least internally) on their GSMM scores and progress on a company or org unit basis.
* Provide high level context and a way into the other projects of the GSF including the TOSS project and the patterns
* Provide high-level context and a way into the other projects of the GSF, including the TOSS project and the patterns

# Deliverables

Expand All @@ -34,13 +34,13 @@ A simple maturity matrix with 5-6 levels of carbon efficiency and awareness in a

## OKRs

Allow any organisation to understand their current green software maturity and know how to actively improve it
* KR: Number of orgs who have self-assessed / adopted standard?
Allow any organization to understand their current green software maturity and know how to actively improve it
* KR: What is the number of organizations that have self-assessed / adopted the standard?
* KR: Digital badges issued?
* KR: Number of organisations who have moved levels?
* KR: What is the number of organizations that have moved levels?

## KPIs
* Online references / backlinks?
* Online references/backlinks?
* Material downloads?
* Case studies?
* Demand for training?
Expand All @@ -53,4 +53,4 @@ Allow any organisation to understand their current green software maturity and k
* Q1 2024 - GSF Project Initiation
* Q2 2024 - v1.0 Community Working Group approval
* Q3 2024 - v1.0 Steering Committee ratification
* Q4 2024 - ?
* Q4 2024 - ?
Loading