-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
b110f25
commit 92a62ed
Showing
1 changed file
with
19 additions
and
8 deletions.
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 |
---|---|---|
@@ -1,13 +1,24 @@ | ||
# Contributing | ||
Thanks for taking the time to contribute! We really appreciate it. | ||
|
||
When contributing to this repository, please first discuss the change you wish to make via issue, | ||
email, or any other method with the owners of this repository before making a change. | ||
The following is a set of guidelines for contributing to any of our [Verbb plugins](https://verbb.io/craft-plugins). These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in an issue or pull request. | ||
|
||
Please note we have a code of conduct, please follow it in all your interactions with the project. | ||
#### Table of Contents | ||
- [Security Disclosures](#security-disclosures) | ||
- [Bug Reports & Feature Requests](#bug-reports--feature-requests) | ||
- [Pull Requests](#pull-requests) | ||
|
||
## Pull Request Process | ||
## Security Disclosures | ||
If you discover a security vulnerability, please review our [Security Policy](https://github.com/verbb/.github/blob/master/SECURITY.md), then report the issue directly to us from [verbb.io/contact](https://verbb.io/contact). We will review and respond privately via email. | ||
|
||
1. Ensure any install or build dependencies are removed before the end of the layer when doing a | ||
build. | ||
2. Update the `CHANGELOG.md` with details of changes to the project. | ||
3. If applicable, update the `README.md` or associated documentation to cover the changes to the project. | ||
## Bug Reports & Feature Requests | ||
Before submitting bug reports and feature requests, please search through open issues to see if yours has already been filed. | ||
|
||
If you do find a similar issue, upvote it by adding a :thumbsup: [reaction](https://github.com/blog/2119-add-reactions-to-pull-requests-issues-and-comments). Only leave a comment if you have relevant information to add. | ||
|
||
If no one has filed the issue yet, submit a new one. Please include a clear description of the issue, and as much relevant information as possible, including a code sample demonstrating the the issue. | ||
|
||
## Pull Requests | ||
Pull requests should clearly describe the problem and solution. Include a reference to any relevant issue if one exists. | ||
|
||
Thanks for being awesome. :cocktail: |