Skip to content

Commit db0d261

Browse files
travisjneumanclaude
travisjneuman
and
claude
committed
feat: add CODE_OF_CONDUCT, issue/PR templates, update .gitignore and LICENSE badge
- CODE_OF_CONDUCT.md (adapted from Contributor Covenant v2.1) - .github/ISSUE_TEMPLATE/ (bug report, feature request, curriculum feedback) - .github/pull_request_template.md - .gitignore: exclude learning/ workspace directory - README.md: update license badge from Open Source to MIT with link - Remove tracked personal file (learning/personalized_plan.md) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f3138b5 commit db0d261

File tree

8 files changed

+132
-34
lines changed

8 files changed

+132
-34
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug Report
3+
about: Report a broken link, failing test, or code error
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear description of the bug.
12+
13+
## Steps to Reproduce
14+
15+
1. Go to '...'
16+
2. Run '...'
17+
3. See error
18+
19+
## Expected Behavior
20+
21+
What should have happened instead.
22+
23+
## Environment
24+
25+
- **OS:** (e.g., Windows 11, macOS 14, Ubuntu 22.04)
26+
- **Python version:** (e.g., 3.11.5)
27+
- **File/document:** (e.g., projects/level-0/01-terminal-hello-lab/README.md)

‎.github/ISSUE_TEMPLATE/curriculum_feedback.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Curriculum Feedback
3+
about: Report unclear explanations, typos, or suggest improvements to existing content
4+
title: '[FEEDBACK] '
5+
labels: curriculum
6+
assignees: ''
7+
---
8+
9+
## Which document or project?
10+
11+
Link or path to the file (e.g., `concepts/how-loops-work.md` or `projects/level-1/05-csv-first-reader`).
12+
13+
## What's unclear or incorrect?
14+
15+
Describe what confused you or what needs fixing.
16+
17+
## Suggested improvement
18+
19+
How would you rewrite or improve this section?
20+
21+
## Your experience level
22+
23+
This helps us calibrate the explanation. (e.g., "complete beginner", "know another language", "intermediate Python")

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
name: Feature Request
3+
about: Suggest a new project, module, or curriculum improvement
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear description of the feature or improvement you'd like.
12+
13+
## Motivation
14+
15+
Why would this be useful? What problem does it solve for learners?
16+
17+
## Proposed Solution
18+
19+
How would you implement this? Which part of the curriculum would it affect?
20+
21+
## Alternatives Considered
22+
23+
Any alternative approaches you've thought about.

‎.github/pull_request_template.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
## Summary
2+
3+
Brief description of what this PR does.
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix (broken link, failing test, code error)
8+
- [ ] New content (project, module, concept guide, quiz)
9+
- [ ] Improvement (clearer explanation, better examples)
10+
- [ ] Documentation (README, comments, tooling docs)
11+
- [ ] Infrastructure (CI, scripts, templates)
12+
13+
## Checklist
14+
15+
- [ ] I have tested any code changes locally
16+
- [ ] Markdown links resolve correctly
17+
- [ ] Content follows curriculum conventions (plain language, hands-on first)
18+
- [ ] New projects match the directory structure of their level
19+
- [ ] I have read [CONTRIBUTING.md](./CONTRIBUTING.md)

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ venv/
88

99
# Flashcard review state (personal progress)
1010
practice/flashcards/.review-state.json
11+
12+
# Personal learning workspace
13+
learning/

‎CODE_OF_CONDUCT.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Code of Conduct
2+
3+
## Our Pledge
4+
5+
We are committed to making participation in this project a welcoming experience for everyone, regardless of background or experience level.
6+
7+
This is a learning community. Everyone starts somewhere. Be patient, be kind, be helpful.
8+
9+
## Our Standards
10+
11+
**Encouraged behavior:**
12+
13+
- Using welcoming and inclusive language
14+
- Being respectful of differing viewpoints and experience levels
15+
- Giving and gracefully accepting constructive feedback
16+
- Focusing on what is best for the learning community
17+
- Showing empathy toward other community members
18+
19+
**Unacceptable behavior:**
20+
21+
- Trolling, insulting, or derogatory comments
22+
- Personal attacks or unwelcome attention
23+
- Publishing others' private information without permission
24+
- Any conduct which could reasonably be considered inappropriate in a professional or educational setting
25+
26+
## Scope
27+
28+
This Code of Conduct applies within all project spaces: issues, pull requests, discussions, and any other communication channels associated with this project.
29+
30+
## Enforcement
31+
32+
Instances of unacceptable behavior may be reported by contacting the project maintainer at **travisjneuman@gmail.com**. All reports will be reviewed and investigated, and will result in a response deemed necessary and appropriate to the circumstances.
33+
34+
## Attribution
35+
36+
This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), version 2.1.

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<img src="https://img.shields.io/badge/Curriculum_Docs-50+-f57c00?style=for-the-badge" alt="50+ Curriculum Docs">
77
<img src="https://img.shields.io/badge/Concept_Guides-16-7c4dff?style=for-the-badge" alt="16 Concept Guides">
88
<img src="https://img.shields.io/badge/Quizzes-15-e53935?style=for-the-badge" alt="15 Quizzes">
9-
<img src="https://img.shields.io/badge/License-Open_Source-555555?style=for-the-badge" alt="Open Source">
9+
<a href="./LICENSE"><img src="https://img.shields.io/badge/License-MIT-blue?style=for-the-badge" alt="MIT License"></a>
1010
</p>
1111

1212
<p align="center">

‎learning/personalized_plan.md‎

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)