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.

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

adding contributing guide #7

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adding contributing guide #7

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
56 changes: 56 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Contributing to FinOps Foundation

:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:

The following is a set of guidelines for contributing to the FinOps Foundation and its content, which are hosted in the [FinOps Foundation Organization](https://github.com/finopsfoundation) on GitHub. These are mostly guidelines, not rules. Use your best judgement, and feel free to propose changes to this document in a pull request.

#### Table Of Contents

[How Can I Contribute?](#how-can-i-contribute)
* [Suggesting Enhancements](#suggesting-enhancements)

## How Can I Contribute?

Contributing to finops.org and the FinOps Framework can include:
* Participating in FinOps Foundation [Special Interest Groups (SIGs) and/or Working Groups (WGs)](https://www.finops.org/projects/overview/) which create new content or edits for the Framework
* Creating issues to identify problems or errors with the finops.org or the FinOps Framework
* Edits to FinOps Framework content, definitions, images, etc.
* Edits to playbooks, reports
* Recommending typo fixes
* Reporting broken links or link updates
* and other content-related fixes

There are multiple ways to submit changes:
* Submit an update via the website page using the button 'Make Suggestion' this automatically creates a GitHub issue
* Create an issue directly [via GitHub](https://github.com/finopsfoundation/framework/issues)
* Make a commit using the [GitHub GUI](https://github.com/finopsfoundation/framework) and submit it for review
* Reach out to the members and team in the [#framework](https://finopsfoundation.slack.com/archives/C01UANLEPDW) slack channel

### Suggesting Enhancements

If submitting an issue/enhancement, please use the issue title to identify what is not working as intended.

e.g. "Broken link on Cost Allocation page" or "Fix typo on Forecasting page"

Use the body of the issue to add additional context, link relevant information about the issue, or upload images to convey context.

e.g. "There's a broken URL in this sentence... The URL should be <URL>", or "Please fix the spelling of the word budget on paragraph three..."

If you don't know how to resolve the issue, that's okay. Reporting it is a very helpful first step.

Please do not assign issues or apply metadata. The FinOps Foundation team will do these for you.


## Licensing

Shield: [![CC BY 4.0][cc-by-shield]][cc-by]

This work is licensed under a
[Creative Commons Attribution 4.0 International License][cc-by].

[![CC BY 4.0][cc-by-image]][cc-by]

[cc-by]: http://creativecommons.org/licenses/by/4.0/
[cc-by-image]: https://i.creativecommons.org/l/by/4.0/88x31.png
[cc-by-shield]: https://img.shields.io/badge/License-CC%20BY%204.0-lightgrey.svg