Skip to content

Commit

Permalink
Merge pull request #425 from Sophietn/dev
Browse files Browse the repository at this point in the history
Updating CONTRIBUTING.md
  • Loading branch information
Sophietn authored Dec 5, 2023
2 parents 80fb686 + 84af21e commit 046e5ec
Showing 1 changed file with 40 additions and 8 deletions.
48 changes: 40 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,52 @@
# GSF Member Contribution Guide

Welcome to the GSF Carbon Aware SDK, and thank you for contributing to this
Welcome to the GSF Carbon Aware SDK, and thank you for your interest in contributing to this
project. This guide outlines the steps for working within the Carbon Aware SDK
and the approved contribution process that members should follow.

**Please contact the project owners for individual contributions. Working Group
meetings and the internal communication channels are only open to GSF Members.**
#### _Before contributing, please read the [GSF Opensource Working Group charter](https://github.com/Green-Software-Foundation/charter/blob/main/charter.md). Any contributions must comply with the charter._ ####

## Table of Contents

- [GSF Member Contribution Guide](#gsf-member-contribution-guide)
- [Table of Contents](#table-of-contents)
- [Summary Steps](#summary-steps)
- [Current Opportunities](#current-opportunities)
- [How To Get Started](#how-to-get-started)
- [Code Contribution Steps](#code-contribution-steps)
- [Public Issues](#public-issues)
- [Collaborating with the OSWG](#collaborating-with-the-opensource-working-group)

## Summary Steps
## Current Opportunities
We have opportunities for both code and non code contributors.

For the following:
We're currently looking for contributions in the following areas:
1. Sample Creation
2. Documentation Updates, including getting docusaurus up and running
3. Video Content Creation (how to enable, demos etc)
4. Slide Deck Creation, available for presenter use, including real time video demo

## How To Get Started
Introduce yourself on on our [discussions page](https://github.com/orgs/Green-Software-Foundation/discussions/65) and let us know where you think you can help.
Find the Project Key contacts in the [Confluence page](https://greensoftwarefoundation.atlassian.net/wiki/spaces/~612dd45e45cd76006a84071a/pages/17137665/Opensource+Carbon+Aware+SDK).

If you are a GSF member organisation employee, you should:
Fill out the [Onboarding form](https://greensoftware.foundation/onboarding/) if you are new to the GSF; or
Fill out the [Subscribe form](https://greensoftware.foundation/subscribe/) if you are already part of the GSF but want to join this project.
Following this, you'll receive an invite to join the Carbon Aware SDK Weekly Meeting.
Only members of the foundation can join meetings and internal conversations.

If you are NOT a GSF member organisation employee, individual contributions are still welcome on our public Github repo eg. raising PRs, joining discussions.

Only our Project Leads have the right to merge PRs.

Any questions, email [email protected].

## Code Contribution Steps

For the following code contribution:

"Member and "Contributor" refer to the GSF member looking to make a feature
contribution. "Chair" refers to the Chair, Co-Chair or other accountable
code contribution. "Chair" refers to the Chair, Co-Chair or other accountable
authority within GSF.

1. Submit a Public Issue using the Issue Template
Expand All @@ -34,6 +61,11 @@ authority within GSF.
for Review" state
7. If the Chair accepts the PR, it merges into `GSF/carbon-aware-sdk/dev`

### Project Release Schedule:
At most once per month.
As frequent as possible.
We prioritise Security release over Feature release. Documentation release is not restricted.

## Public Issues

All contributions to the GSF are tracked through public issues. Please make a
Expand All @@ -43,7 +75,7 @@ issue serves as a commitment by the contributor to developing the feature.
The Issue is **not** a feature request, but tracks expected feature work. Please
do **not** open an issue to request features.

## Collaborating With the WG
## Collaborating With The [Opensource Working Group](https://github.com/Green-Software-Foundation/opensource-wg)

1. Create a
[new Issue](https://github.com/Green-Software-Foundation/standards_wg/issues/new)
Expand Down

0 comments on commit 046e5ec

Please sign in to comment.