Skip to content

Commit 39fd939

Browse files
fix(security): resolve template placeholders and update SCM files (#1)
Security fixes and improvements: - SECURITY.md: Removed template instructions, replaced all placeholders with actual project values (hyperpolymath/eclexia) - CODE_OF_CONDUCT.md: Replaced placeholders, cleaned up template instructions - CONTRIBUTING.md: Fixed malformed file (was missing header), replaced all placeholders with correct values SCM file updates: - ECOSYSTEM.scm: Changed project name from template-repo to eclexia - META.scm: Updated module name and project references - STATE.scm: Updated project state, completion percentage, added session history entry New additions: - ROADMAP.md: Added comprehensive project roadmap with milestones and RSR compliance tracking All files now use correct project information for hyperpolymath/eclexia. Co-authored-by: Claude <noreply@anthropic.com>
1 parent 499e6ba commit 39fd939

File tree

7 files changed

+294
-126
lines changed

7 files changed

+294
-126
lines changed

CODE_OF_CONDUCT.md

Lines changed: 10 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,8 @@
11
# Code of Conduct
22

3-
<!--
4-
============================================================================
5-
TEMPLATE INSTRUCTIONS (delete this block before publishing)
6-
============================================================================
7-
Replace all {{PLACEHOLDER}} values:
8-
{{PROJECT_NAME}} - Your project name
9-
{{OWNER}} - GitHub/GitLab username or org
10-
{{REPO}} - Repository name
11-
{{CONDUCT_EMAIL}} - Email for conduct reports
12-
{{CONDUCT_TEAM}} - Name of conduct team/committee
13-
{{RESPONSE_TIME}} - Initial response SLA (e.g., 48 hours)
14-
{{CURRENT_YEAR}} - Current year
15-
16-
Review and customise:
17-
- Adjust enforcement ladder for your community size
18-
- Add/remove examples based on your context
19-
- Ensure contact methods work for your team
20-
============================================================================
21-
-->
22-
233
## Our Pledge
244

25-
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.
5+
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.
266

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

@@ -136,9 +116,8 @@ If you experience or witness unacceptable behaviour, or have any other concerns,
136116

137117
| Method | Details | Best For |
138118
|--------|---------|----------|
139-
| **Email** | {{CONDUCT_EMAIL}} | Detailed reports, sensitive matters |
119+
| **GitHub** | [Open a private security advisory](https://github.com/hyperpolymath/eclexia/security/advisories/new) | Detailed reports, sensitive matters |
140120
| **Private Message** | Contact any maintainer directly | Quick questions, minor issues |
141-
| **Anonymous Form** | [Link to form if available] | When you need anonymity |
142121

143122
**What to Include**
144123

@@ -152,8 +131,8 @@ If you experience or witness unacceptable behaviour, or have any other concerns,
152131

153132
**What Happens Next**
154133

155-
1. You will receive acknowledgment within **{{RESPONSE_TIME}}**
156-
2. The {{CONDUCT_TEAM}} will review the report
134+
1. You will receive acknowledgment within **48 hours**
135+
2. The maintainers will review the report
157136
3. We may ask for additional information
158137
4. We will determine appropriate action
159138
5. We will inform you of the outcome (respecting others' privacy)
@@ -169,7 +148,7 @@ All reports will be handled with discretion:
169148

170149
### Conflicts of Interest
171150

172-
If a {{CONDUCT_TEAM}} member is involved in an incident:
151+
If a maintainer is involved in an incident:
173152

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

180159
## Enforcement Guidelines
181160

182-
The {{CONDUCT_TEAM}} will follow these guidelines in determining consequences:
161+
The maintainers will follow these guidelines in determining consequences:
183162

184163
### 1. Correction
185164

@@ -231,13 +210,13 @@ For contributors with elevated access (Perimeter 2 or 1):
231210
If you believe an enforcement decision was made in error:
232211

233212
1. **Wait 7 days** after the decision (cooling-off period)
234-
2. **Email** {{CONDUCT_EMAIL}} with subject line "Appeal: [Original Report ID]"
213+
2. **Contact maintainers** via GitHub with subject line "Appeal: [Original Report ID]"
235214
3. **Explain** why you believe the decision should be reconsidered
236215
4. **Provide** any new information not previously available
237216

238217
**Appeals Process**
239218

240-
- Appeals are reviewed by a different {{CONDUCT_TEAM}} member than the original
219+
- Appeals are reviewed by a different maintainer than the original
241220
- You will receive a response within 14 days
242221
- The appeals decision is final
243222
- You may only appeal once per incident
@@ -310,8 +289,7 @@ We thank these communities for their leadership in creating welcoming spaces.
310289

311290
If you have questions about this Code of Conduct:
312291

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

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

325303
---
326304

327-
<sub>Last updated: {{CURRENT_YEAR}} · Based on Contributor Covenant 2.1</sub>
305+
<sub>Last updated: 2025 · Based on Contributor Covenant 2.1</sub>

CONTRIBUTING.md

Lines changed: 121 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,40 @@
1+
# Contributing to Eclexia
2+
3+
Thank you for your interest in contributing to Eclexia! This document provides guidelines and information for contributors.
4+
5+
## Table of Contents
6+
7+
- [Getting Started](#getting-started)
8+
- [How to Contribute](#how-to-contribute)
9+
- [Development Workflow](#development-workflow)
10+
- [Code Standards](#code-standards)
11+
- [Pull Request Process](#pull-request-process)
12+
13+
---
14+
15+
## Getting Started
16+
17+
### Prerequisites
18+
19+
Before contributing, ensure you have:
20+
21+
- Git installed
22+
- A GitHub account
23+
- Familiarity with the project's purpose and structure
24+
25+
### Setting Up Your Environment
26+
27+
```bash
128
# Clone the repository
2-
git clone https://{{FORGE}}/{{OWNER}}/{{REPO}}.git
3-
cd {{REPO}}
29+
git clone https://github.com/hyperpolymath/eclexia.git
30+
cd eclexia
431

532
# Using Nix (recommended for reproducibility)
633
nix develop
734

835
# Or using toolbox/distrobox
9-
toolbox create {{REPO}}-dev
10-
toolbox enter {{REPO}}-dev
36+
toolbox create eclexia-dev
37+
toolbox enter eclexia-dev
1138
# Install dependencies manually
1239

1340
# Verify setup
@@ -16,8 +43,9 @@ just test # Run test suite
1643
```
1744

1845
### Repository Structure
46+
1947
```
20-
{{REPO}}/
48+
eclexia/
2149
├── src/ # Source code (Perimeter 1-2)
2250
├── lib/ # Library code (Perimeter 1-2)
2351
├── extensions/ # Extensions (Perimeter 2)
@@ -53,7 +81,7 @@ just test # Run test suite
5381

5482
**Before reporting**:
5583
1. Search existing issues
56-
2. Check if it's already fixed in `{{MAIN_BRANCH}}`
84+
2. Check if it's already fixed in `main`
5785
3. Determine which perimeter the bug affects
5886

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

87115
Look for issues labelled:
88116

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

94122
---
95123

96124
## Development Workflow
97125

98126
### Branch Naming
127+
99128
```
100129
docs/short-description # Documentation (P3)
101130
test/what-added # Test additions (P3)
@@ -108,9 +137,91 @@ security/what-fixed # Security fixes (P1-2)
108137
### Commit Messages
109138

110139
We follow [Conventional Commits](https://www.conventionalcommits.org/):
140+
111141
```
112142
<type>(<scope>): <description>
113143
114144
[optional body]
115145
116146
[optional footer]
147+
```
148+
149+
**Types**:
150+
- `feat`: New feature
151+
- `fix`: Bug fix
152+
- `docs`: Documentation only
153+
- `style`: Formatting, no code change
154+
- `refactor`: Code change that neither fixes a bug nor adds a feature
155+
- `perf`: Performance improvement
156+
- `test`: Adding or correcting tests
157+
- `chore`: Maintenance tasks
158+
159+
**Examples**:
160+
```
161+
feat(auth): add OAuth2 support for GitHub
162+
fix(parser): handle edge case with empty input
163+
docs(readme): update installation instructions
164+
```
165+
166+
---
167+
168+
## Code Standards
169+
170+
### General Guidelines
171+
172+
- Follow existing code style and patterns
173+
- Write clear, self-documenting code
174+
- Add tests for new functionality
175+
- Update documentation as needed
176+
- Keep commits atomic and focused
177+
178+
### Security
179+
180+
Please review our [Security Policy](SECURITY.md) and ensure your contributions:
181+
182+
- Do not introduce security vulnerabilities
183+
- Follow secure coding practices
184+
- Do not commit secrets or credentials
185+
186+
---
187+
188+
## Pull Request Process
189+
190+
1. **Fork** the repository and create your branch from `main`
191+
2. **Make** your changes following our guidelines
192+
3. **Test** your changes thoroughly
193+
4. **Commit** with clear, conventional commit messages
194+
5. **Push** to your fork
195+
6. **Open** a pull request with:
196+
- Clear description of changes
197+
- Reference to related issues
198+
- Screenshots/examples if applicable
199+
7. **Respond** to review feedback promptly
200+
201+
### Review Criteria
202+
203+
Pull requests are evaluated on:
204+
205+
- Code quality and style consistency
206+
- Test coverage
207+
- Documentation updates
208+
- Security considerations
209+
- Alignment with project goals
210+
211+
---
212+
213+
## Questions?
214+
215+
- Open a [Discussion](https://github.com/hyperpolymath/eclexia/discussions) for general questions
216+
- Check existing issues for similar questions
217+
- Review the [README](README.adoc) for project overview
218+
219+
---
220+
221+
## Code of Conduct
222+
223+
By participating in this project, you agree to abide by our [Code of Conduct](CODE_OF_CONDUCT.md).
224+
225+
---
226+
227+
*Thank you for contributing to Eclexia!*

ECOSYSTEM.scm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
;; SPDX-License-Identifier: AGPL-3.0-or-later
22
;; SPDX-FileCopyrightText: 2025 Jonathan D.A. Jewell
3-
;; ECOSYSTEM.scm — template-repo
3+
;; ECOSYSTEM.scm — eclexia
44

55
(ecosystem
66
(version "1.0.0")
7-
(name "template-repo")
7+
(name "eclexia")
88
(type "project")
99
(purpose "Project in the hyperpolymath ecosystem")
1010

META.scm

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
;; SPDX-License-Identifier: AGPL-3.0-or-later
22
;; SPDX-FileCopyrightText: 2025 Jonathan D.A. Jewell
3-
;;; META.scm — template-repo
3+
;;; META.scm — eclexia
44

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

88
(define architecture-decisions

0 commit comments

Comments
 (0)