green-software-foundation/green-software-playbooks

Green Software Engineering Playbooks

Green Software Playbooks

This project is aimed at providing engineering teams at Information and Communications Technology (ICT) companies the means to determine and make progress towards ensuring their products and practices are built and managed as sustainably as possible. Guidance and recommendations will be categorized based on the type of work the team is engaged in.

This project is run through the Community Working Group in the Green Software Foundation.

Scope

The primary audience is teams of developers and engineers at ICT companies, regardless of size or organization. In particular, development leads and project managers should be able to use the guides to determine what practices and recommendations would make the most sense to follow and provide the most benefit for the effort. Making development teams aware of this resource will be important to its usefulness. This project would be appropriate for any conference aimed at improving development processes and, particularly, sustainable development conferences aimed at helping engineers make their products run cleaner.

This project aims to address:

• Helping teams be more self-directed in improving the sustainability of their products and workflow.
• Helping teams prioritize changes that are the most impactful with the available resources.
• Helping teams identify potential approaches regardless of which division or organization within a company they belong to.

Project Status

This project entered the Green Software Foundation as a Draft on 20 March 2024.

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.

Appointments

The project is lead by:

• Mohammad Haque
• Edwin Cantu

Copyright

This project is copyrighted under Creative Commons Attribution 4.0.

Patent

No Patent License.

License

This project is licensed under the MIT License - see the LICENCE file for details.

Contributing

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

Instructions for how to contribute to this project can be found in the CONTRIBUTING.md file.

green-software-playbooks's Issues

Organise a project kick-off

Context

We would like to hold a project kick-off with all interested parties:

• Take place on 20 June 2024
• Held virtually on Zoom

All interested parties should subscribe to the project to be automatically added to the calendar invite: https://greensoftware.foundation/subscribe

The meeting will be documented on the project wiki:

Actions

• @moin-oss @russelltrow agree a Date & Time
• @russelltrow create calendar invite
• @moin-oss define initial participant list
• @moin-oss @russelltrow build agenda
• @moin-oss announce meeting to CWG

2024-05-23: Project Lead Sync

Attendees

• Project Lead: @moin-oss
• Project Manager: @russelltrow

Agenda

• #3
• Where do we start?
  • What is Version 1.0/MVP?
  • First Milestone?

Define the project's Scope, Objectives & Deliverables

Context

We need to define a detailed description of this project's Scope.

The Scope is mandatory and it describes what the document does. For example, this document

The Scope is written as a series of statements of fact. Don’t put any requirements, recommendations or permissions in the Scope.

• specifies ...
• establishes ...
• gives guidelines for ...
• defines terms ...

e.g. https://github.com/Green-Software-Foundation/scer/wiki/Software-Carbon-Efficiency-Rating

Acceptance Criteria

• Target audience
• Problem Statements
• Scope
• Objectives
• Deliverables
• Definition of Version 1.0

Actions

• Update the README.md
• Update the SCOPE.md

Define the first project milestone

Context

What is the first potential milestone for the project?

• The creation of a first playbook?
• Who is the target audience?
  • Web?
  • Data?

Action

• Review the initial playbook outlines
• Update milestone 1

Logo for Green Software Playbooks project

Context

We need a logo for the project!

Actions

• Design logo
• Add to website project listing
• Update repository with logo

Allow volunteers to subscribe to the Green Software Playbooks project

Context

We want to allow GSF volunteers to subscribe to the project.

Actions

• Setup Google Group - "green-software-playbooks@"
• Add project to project subscription list

Prepare the project for contribution

Context

Now that the Green Software Playbooks project has been formally setup it is time to get it ready for other's within the GSF to start contributing.

We need to clearly define the project and tasks so others can easily understand how and where they can get involved.

Actions

• #2
• Recruiting project co-leads
• #5
  • Agree cadence for project team meetings
• #4
  • Update SCOPE.md
  • Update README.md
• Develop a roadmap and raise initial set of issues
  • Update contribution details with links to GSF subscription form
• Make project available for volunteer subscription
• Coordinate with @NAMRATA-WOKE to create an internal project announcement