Skip to content
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.

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

Add PR template & contributing guide #53

Merged
merged 3 commits into from
Feb 14, 2024
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
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
33 changes: 33 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- Thanks for sending a pull request! Here are some tips for you:

- If this is your first time, please read our contributor guidelines: https://github.com/cncf-tags/green-reviews-tooling/blob/main/CONTRIBUTING.md
- If you want *faster* PR reviews, read the Kubernetes Best Practices: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
-->

#### What type of PR is this?

<!--
Add one of the following kinds:
kind/bug
kind/documentation
kind/feature
kind/enhancement
-->

#### What this PR does / why we need it:

#### Which issue(s) this PR fixes:

<!--
*Automatically closes linked issue when PR is merged.
Usage: `Fixes #<issue number>`, or `Fixes (paste link of issue)`.

Fixes #

or

None
-->

#### Special notes for your reviewer (optional):

39 changes: 39 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Contributing Guide

First and foremost, thank you for contributing to this project led by the
[CNCF Environmental Sustainability TAG](https://github.com/cncf/tag-env-sustainability)!
We really appreciate your time and willingness to contribute. The [Green Reviews
Working Group](https://github.com/cncf/tag-env-sustainability/tree/main/working-groups/green-reviews)
is an entirely volunteer-led open-source project where we innovate
in the open in the hopes of making this architectural reference available to
everyone who operates in a cloud-native environment.

Read on to learn more about the project and how to contribute. As always, please
don't hesitate to ask if anything is unclear. We value questions, guidance, and
suggestions - they help us build the right thing.

### Finding Work

Here are some suggestions for how to find work to contribute to the project.

First, make sure you're up to speed with the project by looking through the resources in the [Getting Started](./README.md#getting-started) guide.

Then, familiarise yourself with the current work and priorities, or find someone who would be willing to pair with you:
- Join the twice monthly [WG meetings](https://github.com/cncf/tag-env-sustainability/tree/main/working-groups/green-reviews#meetings-and-contact).
- [async] Leave a comment in any of the [issues](https://github.com/orgs/cncf/projects/10/views/12).
- [async] Contribute to discussions in the CNCF Slack channel [#wg-green-reviews](https://cloud-native.slack.com/archives/C060EDHN431).

When you feel ready to contribute:
- Check the Backlog in the [issue board](https://github.com/orgs/cncf/projects/10/views/12). More pressing issues are labeled with `good first issue` or `help wanted`.
- If you would like to make a feature request or raise a bug, feel free to [open an issue](https://github.com/cncf-tags/green-reviews-tooling/issues/new).
- _If all else fails_, you could 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. However, the public communication channels listed above are preferred so that we can load-balance the work.

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

### Opening a Pull Request

Recommendations for a faster Pull Request review:
- Please ensure that your commits are **signed** and **verified**.
- **Signed**: Include a `Signed-off-by: Author Name <[email protected]>` in all commits by doing `git rebase HEAD~2 --signoff` (replace `~2` with the number of commits to sign) and then `git push -f`. More info [here](https://github.com/cncf-tags/green-reviews-tooling/pull/53/checks?check_run_id=21563565653).
- **Verified**: [Learn more about commit signature verification with GPG.](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#gpg-commit-signature-verification)
- The Kubernetes Best Practices for faster Reviews is a great resource for PR best practices: https://git.k8s.io/community/contributors/guide/pull-requests.md#best-practices-for-faster-reviews
12 changes: 2 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,10 @@ The aim of the Green Reviews WG is to set up infrastructure to measure the susta
### 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.
- **Issue Board**: Checkout the project's [Backlog](https://github.com/orgs/cncf/projects/10/views/12) to find something to work on.
- **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!
If you are intersted in contributing to the project, head over to the [Contributing Guide](./CONTRIBUTING.md)!
nikimanoledaki marked this conversation as resolved.
Show resolved Hide resolved