Skip to content

Commit

Permalink
add SECURITY and PR template
Browse files Browse the repository at this point in the history
  • Loading branch information
kpicaza committed Oct 14, 2023
1 parent de8bd50 commit 9a00618
Show file tree
Hide file tree
Showing 4 changed files with 46 additions and 1 deletion.
12 changes: 12 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
name: Pull Request
title: 'short description'
---

**Describe the Pull Request**
A clear and concise description of what the Pull Request is and link to existing issue.

- [ ] I read contribution guidelines
- [ ] Pull request introduces a BC-Break
- [ ] Pull request is covered by tests
- [ ] Pull request is properly documented in docs
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,11 @@

![Open Sketch Logo](./storage/app/images/open-sketch-logo.png)

[![Check Coding Standards](https://github.com/kpicaza/open-sketch/actions/workflows/coding-standards.yml/badge.svg)](https://github.com/kpicaza/open-sketch/actions/workflows/coding-standards.yml)
[![PHPUnit tests](https://github.com/kpicaza/open-sketch/actions/workflows/phpunit.yml/badge.svg)](https://github.com/kpicaza/open-sketch/actions/workflows/phpunit.yml)
[![Static Analysis by PHPStan](https://github.com/kpicaza/open-sketch/actions/workflows/phpstan.yml/badge.svg)](https://github.com/kpicaza/open-sketch/actions/workflows/phpstan.yml)
[![Mutation tests](https://github.com/kpicaza/open-sketch/actions/workflows/mutation-tests.yml/badge.svg)](https://github.com/kpicaza/open-sketch/actions/workflows/mutation-tests.yml)

## Table of Contents

* [Introduction](#Introduction)
Expand Down
29 changes: 29 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Security Policy

## Supported Versions

| Version | Supported |
|---------| ------------------ |
| >= 0.5 | :heavy_check_mark: |


## Reporting Potential Security Issues
If you have encountered a potential security vulnerability in this project, please report it to us at [TODO: email address]. We will work with you to verify the vulnerability and patch it.

When reporting issues, please provide the following information:

* Component(s) affected
* A description indicating how to reproduce the issue
* A summary of the security vulnerability and impact
* We request that you contact us via the email address above and give the project contributors a chance to resolve the vulnerability and issue a new release prior to any public exposure; this helps protect the project's users, and provides them with a chance to upgrade and/or update in order to protect their applications.

For sensitive email communications, please use our PGP key.

## Policy
If we verify a reported security vulnerability, our policy is:

* We will patch the current release branch, as well as the immediate prior minor release branch.

* After patching the release branches, we will immediately issue new security fix releases for each patched release branch.

* A security advisory will be released on the project website detailing the vulnerability, as well as recommendations for end-users to protect themselves. Security advisories will be listed at [TODO: website], as well as via a feed (which is also present in the website head for easy feed discovery).
1 change: 0 additions & 1 deletion resources/js/src/pages/OpenSketch.ts
Original file line number Diff line number Diff line change
Expand Up @@ -139,7 +139,6 @@ export class OpenSketch extends LitElement {
]
};


constructor() {
super();
const url = URL.createObjectURL(new Blob());
Expand Down

0 comments on commit 9a00618

Please sign in to comment.