Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
# Clone the repository
git clone https://github.com/hyperpolymath/squisher-corpus.git
cd squisher-corpus
git clone https://github.com/hyperpolymath/pons.git
cd pons

# Using Nix (recommended for reproducibility)
nix develop

# Or using toolbox/distrobox
toolbox create squisher-corpus-dev
toolbox enter squisher-corpus-dev
toolbox create pons-dev
toolbox enter pons-dev
# Install dependencies manually

# Verify setup
Expand All @@ -17,7 +17,7 @@ just test # Run test suite

### Repository Structure
```
squisher-corpus/
pons/
├── src/ # Source code (Perimeter 1-2)
├── lib/ # Library code (Perimeter 1-2)
├── extensions/ # Extensions (Perimeter 2)
Expand Down Expand Up @@ -86,10 +86,10 @@ Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) an

Look for issues labelled:

- [`good first issue`](https://github.com/hyperpolymath/squisher-corpus/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/squisher-corpus/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/squisher-corpus/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/squisher-corpus/labels/perimeter-3) — Community sandbox scope
- [`good first issue`](https://github.com/hyperpolymath/pons/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/pons/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/pons/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/pons/labels/perimeter-3) — Community sandbox scope

---

Expand Down
34 changes: 8 additions & 26 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,5 @@
# Security Policy

<!--
============================================================================
TEMPLATE INSTRUCTIONS (delete this block before publishing)
============================================================================
Replace all {{PLACEHOLDER}} values with your information:
Squisher Corpus - Your project name
hyperpolymath - GitHub username or org (e.g., hyperpolymath)
squisher-corpus - Repository name
j.d.a.jewell@open.ac.uk - Security contact email
TBD - Your PGP key fingerprint (40 chars, no spaces)
https://github.com/hyperpolymath.gpg - URL to your public PGP key
github.com/hyperpolymath/squisher-corpus - Your website/domain
2026 - Current year for copyright

Optional: Remove sections that don't apply (e.g., PGP if you don't use it)
============================================================================
-->

We take security seriously. We appreciate your efforts to responsibly disclose vulnerabilities and will make every effort to acknowledge your contributions.

## Table of Contents
Expand All @@ -40,7 +22,7 @@ We take security seriously. We appreciate your efforts to responsibly disclose v

The preferred method for reporting security vulnerabilities is through GitHub's Security Advisory feature:

1. Navigate to [Report a Vulnerability](https://github.com/hyperpolymath/squisher-corpus/security/advisories/new)
1. Navigate to [Report a Vulnerability](https://github.com/hyperpolymath/pons/security/advisories/new)
2. Click **"Report a vulnerability"**
3. Complete the form with as much detail as possible
4. Submit — we'll receive a private notification
Expand Down Expand Up @@ -203,7 +185,7 @@ If we cannot reach agreement on disclosure timing, we default to 90 days from yo

The following are within scope for security research:

- This repository (`hyperpolymath/squisher-corpus`) and all its code
- This repository (`hyperpolymath/pons`) and all its code
- Official releases and packages published from this repository
- Documentation that could lead to security issues
- Build and deployment configurations in this repository
Expand Down Expand Up @@ -322,7 +304,7 @@ Recognition includes:
To stay informed about security updates:

- **Watch this repository**: Click "Watch" → "Custom" → Select "Security alerts"
- **GitHub Security Advisories**: Published at [Security Advisories](https://github.com/hyperpolymath/squisher-corpus/security/advisories)
- **GitHub Security Advisories**: Published at [Security Advisories](https://github.com/hyperpolymath/pons/security/advisories)
- **Release notes**: Security fixes noted in [CHANGELOG](CHANGELOG.md)

### Update Policy
Expand All @@ -348,7 +330,7 @@ To stay informed about security updates:

## Security Best Practices

When using Squisher Corpus, we recommend:
When using Pons, we recommend:

### General

Expand All @@ -371,7 +353,7 @@ When using Squisher Corpus, we recommend:
## Additional Resources

- [Our PGP Public Key](https://github.com/hyperpolymath.gpg)
- [Security Advisories](https://github.com/hyperpolymath/squisher-corpus/security/advisories)
- [Security Advisories](https://github.com/hyperpolymath/pons/security/advisories)
- [Changelog](CHANGELOG.md)
- [Contributing Guidelines](CONTRIBUTING.md)
- [CVE Database](https://cve.mitre.org/)
Expand All @@ -383,8 +365,8 @@ When using Squisher Corpus, we recommend:

| Purpose | Contact |
|---------|---------|
| **Security issues** | [Report via GitHub](https://github.com/hyperpolymath/squisher-corpus/security/advisories/new) or j.d.a.jewell@open.ac.uk |
| **General questions** | [GitHub Discussions](https://github.com/hyperpolymath/squisher-corpus/discussions) |
| **Security issues** | [Report via GitHub](https://github.com/hyperpolymath/pons/security/advisories/new) or j.d.a.jewell@open.ac.uk |
| **General questions** | [GitHub Discussions](https://github.com/hyperpolymath/pons/discussions) |
| **Other enquiries** | See [README](README.md) for contact information |

---
Expand All @@ -399,7 +381,7 @@ This security policy may be updated from time to time. Significant changes will

---

*Thank you for helping keep Squisher Corpus and its users safe.* 🛡️
*Thank you for helping keep Pons and its users safe.* 🛡️

---

Expand Down
Loading