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
42 changes: 10 additions & 32 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,8 @@
# Code of Conduct

<!--
============================================================================
TEMPLATE INSTRUCTIONS (delete this block before publishing)
============================================================================
Replace all {{PLACEHOLDER}} values:
{{PROJECT_NAME}} - Your project name
{{OWNER}} - GitHub/GitLab username or org
{{REPO}} - Repository name
{{CONDUCT_EMAIL}} - Email for conduct reports
{{CONDUCT_TEAM}} - Name of conduct team/committee
{{RESPONSE_TIME}} - Initial response SLA (e.g., 48 hours)
{{CURRENT_YEAR}} - 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 {{PROJECT_NAME}} 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 Eclexia 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 @@ -136,9 +116,8 @@ If you experience or witness unacceptable behaviour, or have any other concerns,

| Method | Details | Best For |
|--------|---------|----------|
| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters |
| **GitHub** | [Open a private security advisory](https://github.com/hyperpolymath/eclexia/security/advisories/new) | 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 |

**What to Include**

Expand All @@ -152,8 +131,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 **48 hours**
2. The maintainers 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 @@ -169,7 +148,7 @@ All reports will be handled with discretion:

### Conflicts of Interest

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

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

## Enforcement Guidelines

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

### 1. Correction

Expand Down Expand Up @@ -231,13 +210,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. **Contact maintainers** via GitHub 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 maintainer 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 @@ -310,8 +289,7 @@ We thank these communities for their leadership in creating welcoming spaces.

If you have questions about this Code of Conduct:

- Open a [Discussion](https://{{FORGE}}/{{OWNER}}/{{REPO}}/discussions) (for general questions)
- Email {{CONDUCT_EMAIL}} (for private questions)
- Open a [Discussion](https://github.com/hyperpolymath/eclexia/discussions) (for general questions)
- Contact any maintainer directly

---
Expand All @@ -324,4 +302,4 @@ We're all here because we care about this project. Let's make it a place where e

---

<sub>Last updated: {{CURRENT_YEAR}} · Based on Contributor Covenant 2.1</sub>
<sub>Last updated: 2025 · Based on Contributor Covenant 2.1</sub>
131 changes: 121 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,40 @@
# Contributing to Eclexia

Thank you for your interest in contributing to Eclexia! This document provides guidelines and information for contributors.

## Table of Contents

- [Getting Started](#getting-started)
- [How to Contribute](#how-to-contribute)
- [Development Workflow](#development-workflow)
- [Code Standards](#code-standards)
- [Pull Request Process](#pull-request-process)

---

## Getting Started

### Prerequisites

Before contributing, ensure you have:

- Git installed
- A GitHub account
- Familiarity with the project's purpose and structure

### Setting Up Your Environment

```bash
# Clone the repository
git clone https://{{FORGE}}/{{OWNER}}/{{REPO}}.git
cd {{REPO}}
git clone https://github.com/hyperpolymath/eclexia.git
cd eclexia

# Using Nix (recommended for reproducibility)
nix develop

# Or using toolbox/distrobox
toolbox create {{REPO}}-dev
toolbox enter {{REPO}}-dev
toolbox create eclexia-dev
toolbox enter eclexia-dev
# Install dependencies manually

# Verify setup
Expand All @@ -16,8 +43,9 @@ just test # Run test suite
```

### Repository Structure

```
{{REPO}}/
eclexia/
├── src/ # Source code (Perimeter 1-2)
├── lib/ # Library code (Perimeter 1-2)
├── extensions/ # Extensions (Perimeter 2)
Expand Down Expand Up @@ -53,7 +81,7 @@ just test # Run test suite

**Before reporting**:
1. Search existing issues
2. Check if it's already fixed in `{{MAIN_BRANCH}}`
2. Check if it's already fixed in `main`
3. Determine which perimeter the bug affects

**When reporting**:
Expand Down Expand Up @@ -86,16 +114,17 @@ Use the [feature request template](.github/ISSUE_TEMPLATE/feature_request.md) an

Look for issues labelled:

- [`good first issue`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/help%20wanted) — Community help needed
- [`documentation`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/documentation) — Docs improvements
- [`perimeter-3`](https://{{FORGE}}/{{OWNER}}/{{REPO}}/labels/perimeter-3) — Community sandbox scope
- [`good first issue`](https://github.com/hyperpolymath/eclexia/labels/good%20first%20issue) — Simple Perimeter 3 tasks
- [`help wanted`](https://github.com/hyperpolymath/eclexia/labels/help%20wanted) — Community help needed
- [`documentation`](https://github.com/hyperpolymath/eclexia/labels/documentation) — Docs improvements
- [`perimeter-3`](https://github.com/hyperpolymath/eclexia/labels/perimeter-3) — Community sandbox scope

---

## Development Workflow

### Branch Naming

```
docs/short-description # Documentation (P3)
test/what-added # Test additions (P3)
Expand All @@ -108,9 +137,91 @@ security/what-fixed # Security fixes (P1-2)
### Commit Messages

We follow [Conventional Commits](https://www.conventionalcommits.org/):

```
<type>(<scope>): <description>

[optional body]

[optional footer]
```

**Types**:
- `feat`: New feature
- `fix`: Bug fix
- `docs`: Documentation only
- `style`: Formatting, no code change
- `refactor`: Code change that neither fixes a bug nor adds a feature
- `perf`: Performance improvement
- `test`: Adding or correcting tests
- `chore`: Maintenance tasks

**Examples**:
```
feat(auth): add OAuth2 support for GitHub
fix(parser): handle edge case with empty input
docs(readme): update installation instructions
```

---

## Code Standards

### General Guidelines

- Follow existing code style and patterns
- Write clear, self-documenting code
- Add tests for new functionality
- Update documentation as needed
- Keep commits atomic and focused

### Security

Please review our [Security Policy](SECURITY.md) and ensure your contributions:

- Do not introduce security vulnerabilities
- Follow secure coding practices
- Do not commit secrets or credentials

---

## Pull Request Process

1. **Fork** the repository and create your branch from `main`
2. **Make** your changes following our guidelines
3. **Test** your changes thoroughly
4. **Commit** with clear, conventional commit messages
5. **Push** to your fork
6. **Open** a pull request with:
- Clear description of changes
- Reference to related issues
- Screenshots/examples if applicable
7. **Respond** to review feedback promptly

### Review Criteria

Pull requests are evaluated on:

- Code quality and style consistency
- Test coverage
- Documentation updates
- Security considerations
- Alignment with project goals

---

## Questions?

- Open a [Discussion](https://github.com/hyperpolymath/eclexia/discussions) for general questions
- Check existing issues for similar questions
- Review the [README](README.adoc) for project overview

---

## Code of Conduct

By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).

---

*Thank you for contributing to Eclexia!*
4 changes: 2 additions & 2 deletions ECOSYSTEM.scm
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
;; SPDX-License-Identifier: AGPL-3.0-or-later
;; SPDX-FileCopyrightText: 2025 Jonathan D.A. Jewell
;; ECOSYSTEM.scm — template-repo
;; ECOSYSTEM.scm — eclexia

(ecosystem
(version "1.0.0")
(name "template-repo")
(name "eclexia")
(type "project")
(purpose "Project in the hyperpolymath ecosystem")

Expand Down
4 changes: 2 additions & 2 deletions META.scm
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
;; SPDX-License-Identifier: AGPL-3.0-or-later
;; SPDX-FileCopyrightText: 2025 Jonathan D.A. Jewell
;;; META.scm — template-repo
;;; META.scm — eclexia

(define-module (template-repo meta)
(define-module (eclexia meta)
#:export (architecture-decisions development-practices design-rationale))

(define architecture-decisions
Expand Down
Loading
Loading