Skip to content

Commit

Permalink
Bring Py-FSRS up to recommended community standards (#93)
Browse files Browse the repository at this point in the history
* add code of conduct

* add security policy

* set up github issue templates

* add pull request template
  • Loading branch information
joshdavham authored Feb 10, 2025
1 parent a687926 commit 08f351a
Show file tree
Hide file tree
Showing 5 changed files with 46 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
name: Bug Report
about: Report a bug and provide reproduction steps
title: ""
labels: ""
assignees: ""
---

**Which version of py-fsrs?**

<!-- specify which version of py-fsrs you're using -->

**Bug description:**

<!-- describe the bug here -->

**Steps to reproduce the bug:**

<!-- provide a minimum code example to reproduce the bug -->

```python

```
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: true
contact_links:
- name: Questions
url: https://github.com/open-spaced-repetition/py-fsrs/discussions
about: Please ask general questions here instead of opening an issue.
2 changes: 2 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
<!--If this PR resolves an issue, link its number below. Otherwise, delete the line.-->
Closes #ISSUE_NUMBER
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Code of Conduct

Always be respectful, assume good intent and try to stay on topic as much as possible.
13 changes: 13 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Security policy

## Supported versions

Only the latest version of py-fsrs will be supported with security updates. You can find the lastest version of py-fsrs [here](https://github.com/open-spaced-repetition/py-fsrs/releases/latest).

## Reporting a security vulnerability

If you find a security vulnerability with py-fsrs, we'd like to know!

For non-severe vulnerabilites, please just open a normal [issue](https://github.com/open-spaced-repetition/py-fsrs/issues).

For more severe security vulnerabilities, please report it [here](https://github.com/open-spaced-repetition/py-fsrs/security/advisories/new).

0 comments on commit 08f351a

Please sign in to comment.