-
Notifications
You must be signed in to change notification settings - Fork 1
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
Changes from 4 commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
74799a2
docs: add CONTRIBUTING.md
jtieri eb71990
Merge remote-tracking branch 'origin' into justin/contributor-doc
jtieri f65ae88
docs: update CONTRIBUTING.md to include section on contributor licens…
jtieri a908019
Merge remote-tracking branch 'origin' into justin/contributor-doc
jtieri c83c6db
docs: update CONTRIBUTING.md section on reporting security issues
jtieri 85f3680
docs: add secondary contact method to SECURITY.md
jtieri File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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, | ||
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. |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
fileThere was a problem hiding this comment.
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 ofCONTRIBUTING.md