Skip to content

Create Onboarding Guide #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 17, 2022
Merged

Create Onboarding Guide #25

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
19 changes: 13 additions & 6 deletions docs/onboarding_guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,18 @@ import Image from "@theme/IdealImage";

# Onboarding (In Draft)

<div class="intro-logo">
<img src="/img/logo.svg" alt="logo" />
</div>
<br />
<br />
Thank you for your interesting in participating in the Standards Working Group! We're excited to have you contribute to this project.

## Onboarding
To get the most out of the working group we've created a few resources to get you up to speed:

## Read the Specification
The specification forms the foundation of everything that this working group focuses on. We suggest that you read the SCI specification cover to cover (don't worry, it's not that long!). Not only will you be intimately familiar with this key document, but your fresh eyes will help identify gaps and limitations in the current specification. If there are areas that you have questions about and want to dig deeper, we suggest looking at the FAQ (forthcoming). If questions remain or there are ambiguities, this may be a perfect area that you can help us improve the specification. The most recent version of the specificaiton can be found here <link> (it might be wise to view the 'dev' branch to see the current draft version as well).
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The specification forms the foundation of everything that this working group focuses on. We suggest that you read the SCI specification cover to cover (don't worry, it's not that long!). Not only will you be intimately familiar with this key document, but your fresh eyes will help identify gaps and limitations in the current specification. If there are areas that you have questions about and want to dig deeper, we suggest looking at the FAQ (forthcoming). If questions remain or there are ambiguities, this may be a perfect area that you can help us improve the specification. The most recent version of the specificaiton can be found here <link> (it might be wise to view the 'dev' branch to see the current draft version as well).
The specification forms the foundation of everything that this working group focuses on. We suggest that you read the SCI specification cover to cover (don't worry, it's not that long!). Not only will you be intimately familiar with this key document, but your fresh eyes will help identify gaps and limitations in the current specification. If there are areas that you have questions about and want to dig deeper, we suggest looking at the FAQ (forthcoming). If questions remain or there are ambiguities, this may be a perfect area that you can help us improve the specification. The most recent version of the specificaiton can be found [here](https://github.com/Green-Software-Foundation/software_carbon_intensity) (it might be wise to view the 'dev' branch to see the current draft version as well).

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The specification forms the foundation of everything that this working group focuses on. We suggest that you read the SCI specification cover to cover (don't worry, it's not that long!). Not only will you be intimately familiar with this key document, but your fresh eyes will help identify gaps and limitations in the current specification. If there are areas that you have questions about and want to dig deeper, we suggest looking at the FAQ (forthcoming). If questions remain or there are ambiguities, this may be a perfect area that you can help us improve the specification. The most recent version of the specificaiton can be found here <link> (it might be wise to view the 'dev' branch to see the current draft version as well).
The specification forms the foundation of everything that this working group focuses on. We suggest that you read the SCI specification cover to cover (don't worry, it's not that long!). Not only will you be intimately familiar with this key document, but your fresh eyes will help identify gaps and limitations in the current specification. If there are areas that you have questions about and want to dig deeper, we suggest looking at the FAQ (forthcoming). If questions remain or there are ambiguities, this may be a perfect area that you can help us improve the specification. The most recent version of the specification can be found here <link> (it might be wise to view the 'dev' branch to see the current draft version as well).


## Onboarding Session
Once a month the working group asks all new members to briefly introduce themselves and explain their interest in the Standards Working group at the beginning of the regularly scheduled working group call. This is a great time to raise any questions about the specification or indicate areas of expertise that you can contribute to.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once a month the working group asks all new members to briefly introduce themselves and explain their interest in the Standards Working group at the beginning of the regularly scheduled working group call. This is a great time to raise any questions about the specification or indicate areas of expertise that you can contribute to.
At the first working group meeting of the month we ask all new members to briefly introduce themselves and explain their interest in the Standards Working group at the beginning of the regularly scheduled working group call. This is a great time to raise any questions about the specification or indicate areas of expertise that you can contribute to.


## Mentor for New Members
We assign a 'buddy' to new members who can answer questions, orient you to key topics, and generally support getting you up to speed so that you can meaningfully contribute to the working group. You and the mentor should work out the most effective way for you to communicate, whether by call, email, or other messaging platform.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Time Commitment
We expect working group member to attend the weekly hourlong meetings as well as contribute to the the specification between meetings. There may be other project specific work that the working group may engage on as well.

## Operations
The 'How We Work' <link> section explains how we work by consensus, when we meet, what projects we are working on, and some other details of how to contribute.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The 'How We Work' <link> section explains how we work by consensus, when we meet, what projects we are working on, and some other details of how to contribute.
The ['How We Work'](https://standards.greensoftware.foundation/#how-we-work) section explains how we work by consensus, when we meet, what projects we are working on, and some other details of how to contribute.