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
40 changes: 10 additions & 30 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,9 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
# Code of Conduct

<!--
============================================================================
TEMPLATE INSTRUCTIONS (delete this block before publishing)
============================================================================
Replace all {{PLACEHOLDER}} values:
Nextgen Languages - Your project name
hyperpolymath - GitHub/GitLab username or org
nextgen-languages - Repository name
{{CONDUCT_EMAIL}} - Email for conduct reports
{{CONDUCT_TEAM}} - Name of conduct team/committee
{{RESPONSE_TIME}} - Initial response SLA (e.g., 48 hours)
2026 - Current year

Review and customise:
- Adjust enforcement ladder for your community size
- Add/remove examples based on your context
- Ensure contact methods work for your team
============================================================================
-->

## Our Pledge

We as members, contributors, and leaders pledge to make participation in Nextgen Languages a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.
We as members, contributors, and leaders pledge to make participation in tangle a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, colour, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

Expand Down Expand Up @@ -140,7 +120,7 @@ If you experience or witness unacceptable behaviour, or have any other concerns,

| Method | Details | Best For |
|--------|---------|----------|
| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters |
| **Email** | 6759885+hyperpolymath@users.noreply.github.com | Detailed reports, sensitive matters |
| **Private Message** | Contact any maintainer directly | Quick questions, minor issues |
| **Anonymous Form** | [Link to form if available] | When you need anonymity |

Expand All @@ -156,8 +136,8 @@ If you experience or witness unacceptable behaviour, or have any other concerns,

**What Happens Next**

1. You will receive acknowledgment within **{{RESPONSE_TIME}}**
2. The {{CONDUCT_TEAM}} will review the report
1. You will receive acknowledgment within **5 working days**
2. The conduct team will review the report
3. We may ask for additional information
4. We will determine appropriate action
5. We will inform you of the outcome (respecting others' privacy)
Expand All @@ -173,7 +153,7 @@ All reports will be handled with discretion:

### Conflicts of Interest

If a {{CONDUCT_TEAM}} member is involved in an incident:
If a conduct team member is involved in an incident:

- They will recuse themselves from the process
- Another maintainer or external party will handle the report
Expand All @@ -183,7 +163,7 @@ If a {{CONDUCT_TEAM}} member is involved in an incident:

## Enforcement Guidelines

The {{CONDUCT_TEAM}} will follow these guidelines in determining consequences:
The conduct team will follow these guidelines in determining consequences:

### 1. Correction

Expand Down Expand Up @@ -235,13 +215,13 @@ For contributors with elevated access (Perimeter 2 or 1):
If you believe an enforcement decision was made in error:

1. **Wait 7 days** after the decision (cooling-off period)
2. **Email** {{CONDUCT_EMAIL}} with subject line "Appeal: [Original Report ID]"
2. **Email** 6759885+hyperpolymath@users.noreply.github.com with subject line "Appeal: [Original Report ID]"
3. **Explain** why you believe the decision should be reconsidered
4. **Provide** any new information not previously available

**Appeals Process**

- Appeals are reviewed by a different {{CONDUCT_TEAM}} member than the original
- Appeals are reviewed by a different conduct team member than the original
- You will receive a response within 14 days
- The appeals decision is final
- You may only appeal once per incident
Expand Down Expand Up @@ -314,8 +294,8 @@ We thank these communities for their leadership in creating welcoming spaces.

If you have questions about this Code of Conduct:

- Open a [Discussion](https://github.com/hyperpolymath/nextgen-languages/discussions) (for general questions)
- Email {{CONDUCT_EMAIL}} (for private questions)
- Open a [Discussion](https://github.com/hyperpolymath/tangle/discussions) (for general questions)
- Email 6759885+hyperpolymath@users.noreply.github.com (for private questions)
- Contact any maintainer directly

---
Expand Down
18 changes: 9 additions & 9 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ SPDX-License-Identifier: MPL-2.0
Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
# Clone the repository
git clone https://github.com/hyperpolymath/nextgen-languages.git
cd nextgen-languages
git clone https://github.com/hyperpolymath/tangle.git
cd tangle

# Using Nix (recommended for reproducibility)
nix develop

# Or using toolbox/distrobox
toolbox create nextgen-languages-dev
toolbox enter nextgen-languages-dev
toolbox create tangle-dev
toolbox enter tangle-dev
# Install dependencies manually

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

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

Look for issues labelled:

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

---

Expand Down
59 changes: 13 additions & 46 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,6 @@ Copyright (c) Jonathan D.A. Jewell <j.d.a.jewell@open.ac.uk>
-->
# Security Policy

<!--
============================================================================
TEMPLATE INSTRUCTIONS (delete this block before publishing)
============================================================================
Replace all {{PLACEHOLDER}} values with your information:
Nextgen Languages - Your project name
hyperpolymath - GitHub username or org (e.g., hyperpolymath)
nextgen-languages - Repository name
6759885+hyperpolymath@users.noreply.github.com - Security contact email
[PGP fingerprint not set] - Your PGP key fingerprint (40 chars, no spaces)
{{PGP_KEY_URL}} - URL to your public PGP key
{{WEBSITE}} - 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 @@ -44,7 +26,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/nextgen-languages/security/advisories/new)
1. Navigate to [Report a Vulnerability](https://github.com/hyperpolymath/tangle/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 All @@ -56,26 +38,12 @@ This method ensures:
- Coordinated disclosure tooling
- Automatic credit when the advisory is published

### Alternative: Encrypted Email

If you cannot use GitHub Security Advisories, you may email us directly:

| | |
|---|---|
| **Email** | 6759885+hyperpolymath@users.noreply.github.com |
| **PGP Key** | [Download Public Key]({{PGP_KEY_URL}}) |
| **Fingerprint** | `[PGP fingerprint not set]` |
### Alternative: Email

```bash
# Import our PGP key
curl -sSL {{PGP_KEY_URL}} | gpg --import

# Verify fingerprint
gpg --fingerprint 6759885+hyperpolymath@users.noreply.github.com

# Encrypt your report
gpg --armor --encrypt --recipient 6759885+hyperpolymath@users.noreply.github.com report.txt
```
If you cannot use GitHub Security Advisories, email us directly at
6759885+hyperpolymath@users.noreply.github.com. No PGP key is currently
published; for an encrypted channel, request one via a GitHub Security
Advisory.

> **⚠️ Important:** Do not report security vulnerabilities through public GitHub issues, pull requests, discussions, or social media.

Expand Down Expand Up @@ -207,7 +175,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/nextgen-languages`) and all its code
- This repository (`hyperpolymath/tangle`) 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 @@ -326,7 +294,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/nextgen-languages/security/advisories)
- **GitHub Security Advisories**: Published at [Security Advisories](https://github.com/hyperpolymath/tangle/security/advisories)
- **Release notes**: Security fixes noted in [CHANGELOG](CHANGELOG.md)

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

## Security Best Practices

When using Nextgen Languages, we recommend:
When using tangle, we recommend:

### General

Expand All @@ -374,8 +342,7 @@ When using Nextgen Languages, we recommend:

## Additional Resources

- [Our PGP Public Key]({{PGP_KEY_URL}})
- [Security Advisories](https://github.com/hyperpolymath/nextgen-languages/security/advisories)
- [Security Advisories](https://github.com/hyperpolymath/tangle/security/advisories)
- [Changelog](CHANGELOG.md)
- [Contributing Guidelines](CONTRIBUTING.md)
- [CVE Database](https://cve.mitre.org/)
Expand All @@ -387,8 +354,8 @@ When using Nextgen Languages, we recommend:

| Purpose | Contact |
|---------|---------|
| **Security issues** | [Report via GitHub](https://github.com/hyperpolymath/nextgen-languages/security/advisories/new) or 6759885+hyperpolymath@users.noreply.github.com |
| **General questions** | [GitHub Discussions](https://github.com/hyperpolymath/nextgen-languages/discussions) |
| **Security issues** | [Report via GitHub](https://github.com/hyperpolymath/tangle/security/advisories/new) or 6759885+hyperpolymath@users.noreply.github.com |
| **General questions** | [GitHub Discussions](https://github.com/hyperpolymath/tangle/discussions) |
| **Other enquiries** | See [README](README.md) for contact information |

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

---

*Thank you for helping keep Nextgen Languages and its users safe.* 🛡️
*Thank you for helping keep tangle and its users safe.* 🛡️

---

Expand Down
Loading