Skip to content

Commit 2f2fec9

Browse files
rubenmarcusrubenmarcus
authored
Merge pull request #60 from rubenmarcus/feat/oss-best-practices
docs: add OSS best practices and community health files
2 parents b620cb2 + 53b2b80 commit 2f2fec9

File tree

12 files changed

+690
-31
lines changed

12 files changed

+690
-31
lines changed

‎.github/CODEOWNERS‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# CODEOWNERS - defines who is responsible for code review
2+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
3+
4+
# Default owner for everything
5+
* @rubenmarcus
6+
7+
# Core CLI source code
8+
/src/ @rubenmarcus
9+
10+
# Documentation
11+
/docs/ @rubenmarcus
12+
*.md @rubenmarcus
13+
14+
# CI/CD and GitHub configuration
15+
/.github/ @rubenmarcus
16+
17+
# Package configuration
18+
package.json @rubenmarcus
19+
package-lock.json @rubenmarcus
20+
tsconfig.json @rubenmarcus

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: Bug Report
2+
description: Report a bug or unexpected behavior
3+
title: "[Bug]: "
4+
labels: ["bug", "triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to report a bug! Please fill out the form below.
10+
11+
- type: textarea
12+
id: description
13+
attributes:
14+
label: Bug Description
15+
description: A clear and concise description of the bug
16+
placeholder: Describe what happened...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: reproduction
22+
attributes:
23+
label: Steps to Reproduce
24+
description: Steps to reproduce the behavior
25+
placeholder: |
26+
1. Run `ralph ...`
27+
2. Select '...'
28+
3. See error
29+
validations:
30+
required: true
31+
32+
- type: textarea
33+
id: expected
34+
attributes:
35+
label: Expected Behavior
36+
description: What did you expect to happen?
37+
validations:
38+
required: true
39+
40+
- type: textarea
41+
id: actual
42+
attributes:
43+
label: Actual Behavior
44+
description: What actually happened?
45+
validations:
46+
required: true
47+
48+
- type: input
49+
id: version
50+
attributes:
51+
label: ralph-starter Version
52+
description: Run `ralph --version` to get this
53+
placeholder: "0.1.1"
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: os
59+
attributes:
60+
label: Operating System
61+
options:
62+
- macOS
63+
- Linux
64+
- Windows (WSL)
65+
- Windows
66+
- Other
67+
validations:
68+
required: true
69+
70+
- type: input
71+
id: node-version
72+
attributes:
73+
label: Node.js Version
74+
description: Run `node --version` to get this
75+
placeholder: "v20.10.0"
76+
validations:
77+
required: true
78+
79+
- type: textarea
80+
id: logs
81+
attributes:
82+
label: Relevant Logs
83+
description: Please paste any relevant error logs or output
84+
render: shell
85+
86+
- type: textarea
87+
id: additional
88+
attributes:
89+
label: Additional Context
90+
description: Any other context about the problem (screenshots, config, etc.)

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Documentation
4+
url: https://ralph-starter.dev/docs
5+
about: Check the documentation for answers to common questions
6+
- name: Discussions
7+
url: https://github.com/rubenmarcus/ralph-starter/discussions
8+
about: Ask questions and discuss ideas with the community

‎.github/ISSUE_TEMPLATE/config_issue.yml‎

Lines changed: 89 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,89 @@
1+
name: Configuration Issue
2+
description: Report issues with configuration or setup
3+
title: "[Config]: "
4+
labels: ["configuration", "help wanted"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Having trouble with configuration? Let us help!
10+
11+
- type: dropdown
12+
id: integration
13+
attributes:
14+
label: Which integration?
15+
description: Which service or integration is this related to?
16+
options:
17+
- General Setup
18+
- Anthropic (Claude)
19+
- OpenAI
20+
- OpenRouter
21+
- Linear
22+
- Notion
23+
- GitHub
24+
- Todoist
25+
- Other
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: description
31+
attributes:
32+
label: Issue Description
33+
description: Describe the configuration issue you're experiencing
34+
placeholder: When I try to configure...
35+
validations:
36+
required: true
37+
38+
- type: textarea
39+
id: steps
40+
attributes:
41+
label: Steps Taken
42+
description: What have you tried so far?
43+
placeholder: |
44+
1. Ran `ralph config`
45+
2. Entered API key
46+
3. Got error...
47+
validations:
48+
required: true
49+
50+
- type: textarea
51+
id: error
52+
attributes:
53+
label: Error Message
54+
description: Any error messages you're seeing
55+
render: shell
56+
57+
- type: textarea
58+
id: config
59+
attributes:
60+
label: Configuration (sanitized)
61+
description: "Relevant config (REMOVE any API keys or secrets!)"
62+
render: json
63+
64+
- type: input
65+
id: version
66+
attributes:
67+
label: ralph-starter Version
68+
placeholder: "0.1.1"
69+
validations:
70+
required: true
71+
72+
- type: dropdown
73+
id: os
74+
attributes:
75+
label: Operating System
76+
options:
77+
- macOS
78+
- Linux
79+
- Windows (WSL)
80+
- Windows
81+
- Other
82+
validations:
83+
required: true
84+
85+
- type: textarea
86+
id: additional
87+
attributes:
88+
label: Additional Context
89+
description: Any other relevant information

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 74 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
name: Feature Request
2+
description: Suggest a new feature or enhancement
3+
title: "[Feature]: "
4+
labels: ["enhancement"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for suggesting a feature! Please describe your idea below.
10+
11+
- type: textarea
12+
id: problem
13+
attributes:
14+
label: Problem Statement
15+
description: What problem does this feature solve? Is it related to a frustration?
16+
placeholder: I'm always frustrated when...
17+
validations:
18+
required: true
19+
20+
- type: textarea
21+
id: solution
22+
attributes:
23+
label: Proposed Solution
24+
description: Describe your ideal solution
25+
placeholder: I would like ralph to...
26+
validations:
27+
required: true
28+
29+
- type: textarea
30+
id: alternatives
31+
attributes:
32+
label: Alternatives Considered
33+
description: Any alternative solutions or features you've considered?
34+
35+
- type: dropdown
36+
id: category
37+
attributes:
38+
label: Feature Category
39+
options:
40+
- New Integration (Linear, Notion, GitHub, etc.)
41+
- CLI Experience
42+
- AI/LLM Enhancement
43+
- Configuration
44+
- Documentation
45+
- Performance
46+
- Other
47+
validations:
48+
required: true
49+
50+
- type: dropdown
51+
id: scope
52+
attributes:
53+
label: Scope
54+
description: How significant is this change?
55+
options:
56+
- Small (minor tweak)
57+
- Medium (new command or option)
58+
- Large (major feature or new integration)
59+
validations:
60+
required: true
61+
62+
- type: checkboxes
63+
id: contribution
64+
attributes:
65+
label: Contribution
66+
options:
67+
- label: I would be willing to help implement this feature
68+
required: false
69+
70+
- type: textarea
71+
id: additional
72+
attributes:
73+
label: Additional Context
74+
description: Any other context, mockups, or examples

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
## Summary
2+
3+
<!-- Brief description of what this PR does -->
4+
5+
## Type of Change
6+
7+
- [ ] Bug fix (non-breaking change that fixes an issue)
8+
- [ ] New feature (non-breaking change that adds functionality)
9+
- [ ] Breaking change (fix or feature that would cause existing functionality to change)
10+
- [ ] Documentation update
11+
- [ ] Refactoring (no functional changes)
12+
- [ ] CI/CD or tooling changes
13+
14+
## Related Issues
15+
16+
<!-- Link any related issues: Fixes #123, Closes #456 -->
17+
18+
## Changes Made
19+
20+
<!-- List the specific changes made in this PR -->
21+
22+
-
23+
24+
## Testing
25+
26+
<!-- Describe how you tested these changes -->
27+
28+
- [ ] I have tested this locally
29+
- [ ] I have added/updated tests as needed
30+
- [ ] All existing tests pass (`npm test`)
31+
32+
## Checklist
33+
34+
- [ ] My code follows the project's coding style (`npm run lint`)
35+
- [ ] I have performed a self-review of my code
36+
- [ ] I have commented my code where necessary
37+
- [ ] I have updated documentation as needed
38+
- [ ] My changes generate no new warnings
39+
- [ ] Any dependent changes have been merged and published
40+
41+
## Screenshots (if applicable)
42+
43+
<!-- Add screenshots for UI changes -->
44+
45+
## Additional Notes
46+
47+
<!-- Any additional information for reviewers -->

‎.github/dependabot.yml‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
version: 2
2+
updates:
3+
# Main CLI package
4+
- package-ecosystem: "npm"
5+
directory: "/"
6+
schedule:
7+
interval: "weekly"
8+
day: "monday"
9+
open-pull-requests-limit: 10
10+
labels:
11+
- "dependencies"
12+
- "npm"
13+
commit-message:
14+
prefix: "chore(deps)"
15+
groups:
16+
typescript:
17+
patterns:
18+
- "typescript"
19+
- "@types/*"
20+
testing:
21+
patterns:
22+
- "vitest"
23+
- "@vitest/*"
24+
linting:
25+
patterns:
26+
- "biome"
27+
- "@biomejs/*"
28+
- "commitlint"
29+
- "@commitlint/*"
30+
31+
# Documentation site
32+
- package-ecosystem: "npm"
33+
directory: "/docs"
34+
schedule:
35+
interval: "weekly"
36+
day: "monday"
37+
open-pull-requests-limit: 5
38+
labels:
39+
- "dependencies"
40+
- "npm"
41+
- "documentation"
42+
commit-message:
43+
prefix: "chore(deps)"
44+
45+
# GitHub Actions
46+
- package-ecosystem: "github-actions"
47+
directory: "/"
48+
schedule:
49+
interval: "weekly"
50+
day: "monday"
51+
labels:
52+
- "dependencies"
53+
- "github-actions"
54+
commit-message:
55+
prefix: "chore(deps)"

0 commit comments

Comments
 (0)