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

docs: add CONTRIBUTING.md #2

Merged
merged 6 commits into from
Jun 5, 2024
Merged
Changes from 3 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
54 changes: 54 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# Contributor Guidelines

## Introduction

Welcome to the Strangelove contributor guidelines. We are excited to have you here and look forward to your contributions!
Contributors are expected to adhere to the guidelines outlined in this document as well as our [code of conduct](./CODE_OF_CONDUCT.md).

## Contributing

There are many ways to contribute, from writing tutorials or blog posts, improving the documentation,
submitting bug reports and feature requests, or writing code which can be incorporated into the project itself.

### Bug Reports

First thing to note is that if you believe you have discovered a security vulnerability *DO NOT* use the issue tracker.
Please report it via email to [email protected]. For more information on reporting security vulnerabilities,
Copy link
Contributor

Choose a reason for hiding this comment

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

We have a couple ways for folks to report. I do like having the more official automated way for people who are security aware, and this dead simple obvious way for others.

Just calling it out that we might have two channels to monitor, but I'm okay with that.

Copy link
Contributor Author

@jtieri jtieri Jun 4, 2024

Choose a reason for hiding this comment

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

good call out, this was before we recently decided to make use of the security vulnerability reporting via GitHub. I could add a sentence here pointing to our SECURITY.md file which would direct folks to the built in reporting functionality on GitHub but also leave our email in place as a secondary option?

or i could just remove our email and only link to our SECURITY.md file

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I ended up adding our email as a secondary option to SECURITY.md and pointed users to this document inside of CONTRIBUTING.md

please see our [security policy](./SECURITY.md).

When creating a bug report, please use the [template](./.github/ISSUE_TEMPLATE/bug_report.yml) and include as much
detail as possible. At a minimum be sure to include the following:
- What you were trying to do
- How the bug can be reproduced
- What you expected to happen
- What version of the software you were using

### Feature Requests & Enhancements

Feature requests and other enhancements can be made using the [template](./.github/ISSUE_TEMPLATE/feature_request.yml) provided.
Please provide as much detail as possible, including the problem you are trying to solve and the solution you would like to see,
along with possible alternatives you have considered if applicable. Understanding the use cases and the benefits the new feature
or enhancement would bring to users helps the team to prioritize and implement the feature.

### Doc Changes

Documentation changes are always welcome. If you see a typo, or would like to improve the documentation in any way feel
free to open a PR. If you are unsure about the changes you would like to make or if the changes go well beyond
addressing simple grammar mistakes or formatting, open an issue to discuss the changes before opening a PR.

### Opening PRs

When opening new PRs it is advised to open an issue first to discuss the changes you would like to make.
This helps to ensure that the changes are in line with the project goals and that the team is aware of the changes being made
so that duplicate efforts are not made and everyone's time is used efficiently.

When opening a PR, please ensure that the PR description includes the issue number that the PR is addressing.
This helps to ensure that the PR is linked to the issue and that the issue is closed when the PR is merged.


### Contributor License Agreement

Before opening a PR, please review LICENSE.md and familiarize yourself with its terms.
Please be advised that by opening a PR, you are granting Strangelove (or the owner of the relevant repository) a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable license, in copyright and in patent, with respect to your
Contribution and any portion thereof.
Loading