Skip to content

Commit a6d91c5

Browse files
dines-rldines-rl
authored
feat: prepared repo for open source contributions! (#29)
1 parent 59eeb0e commit a6d91c5

22 files changed

Lines changed: 1437 additions & 833 deletions

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
name: Bug Report
3+
about: Create a report to help us improve
4+
title: '[BUG] '
5+
labels: bug
6+
assignees: ''
7+
---
8+
9+
## Description
10+
11+
A clear and concise description of what the bug is.
12+
13+
## Steps to Reproduce
14+
15+
1. Run command '...'
16+
2. See error
17+
18+
## Expected Behavior
19+
20+
A clear and concise description of what you expected to happen.
21+
22+
## Actual Behavior
23+
24+
A clear and concise description of what actually happened.
25+
26+
## Environment
27+
28+
- OS: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11]
29+
- Node.js version: [e.g., 20.10.0]
30+
- CLI version: [e.g., 0.7.0]
31+
- Terminal: [e.g., iTerm2, Terminal.app, Windows Terminal]
32+
33+
## Additional Context
34+
35+
Add any other context about the problem here.
36+
37+
## Screenshots/Logs
38+
39+
If applicable, add screenshots or logs to help explain your problem.
40+
41+
```bash
42+
# Paste relevant logs here
43+
```

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature Request
3+
about: Suggest an idea for this project
4+
title: '[FEATURE] '
5+
labels: enhancement
6+
assignees: ''
7+
---
8+
9+
## Problem Statement
10+
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
## Proposed Solution
14+
15+
A clear and concise description of what you want to happen.
16+
17+
## Alternatives Considered
18+
19+
A clear and concise description of any alternative solutions or features you've considered.
20+
21+
## Use Case
22+
23+
Describe the use case or scenario where this feature would be helpful.
24+
25+
## Additional Context
26+
27+
Add any other context, mockups, or examples about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## Description
2+
3+
<!-- Provide a brief description of your changes -->
4+
5+
**Note:** PR titles should follow [Conventional Commits](https://www.conventionalcommits.org/) format (e.g., `feat(devbox): add support for custom env vars` or `fix(snapshot): resolve pagination issue`) as they are used for automatic release notes generation.
6+
7+
## Type of Change
8+
9+
<!-- Mark the relevant option with an 'x' -->
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] Documentation update
15+
- [ ] Code refactoring
16+
- [ ] Performance improvement
17+
- [ ] Test updates
18+
19+
## Related Issues
20+
21+
<!-- Link to related issues using #issue-number -->
22+
Closes #
23+
24+
## Changes Made
25+
26+
<!-- Describe the changes in detail -->
27+
28+
## Testing
29+
30+
<!-- Describe how you tested your changes -->
31+
32+
- [ ] I have tested locally
33+
- [ ] I have added/updated tests
34+
- [ ] All existing tests pass
35+
36+
## Checklist
37+
38+
- [ ] My code follows the code style of this project
39+
- [ ] I have performed a self-review of my own code
40+
- [ ] I have commented my code, particularly in hard-to-understand areas
41+
- [ ] I have updated the documentation accordingly
42+
- [ ] My changes generate no new warnings
43+
- [ ] I have added tests that prove my fix is effective or that my feature works
44+
- [ ] New and existing unit tests pass locally with my changes
45+
- [ ] Any dependent changes have been merged and published
46+
47+
## Screenshots (if applicable)
48+
49+
<!-- Add screenshots to help explain your changes -->
50+
51+
## Additional Notes
52+
53+
<!-- Any additional information that reviewers should know -->

‎.github/workflows/ci.yml‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,17 @@ name: CI
22

33
on:
44
pull_request:
5-
types: [opened, synchronize, reopened]
65
workflow_dispatch:
76

87
jobs:
98
format:
109
runs-on: ubuntu-latest
1110
steps:
1211
- name: Checkout code
13-
uses: runloopai/checkout@main
12+
uses: actions/checkout@v4
1413

1514
- name: Setup Node.js
16-
uses: runloopai/setup-node@main
15+
uses: actions/setup-node@v4
1716
with:
1817
node-version: "20"
1918
cache: "npm"
@@ -28,10 +27,10 @@ jobs:
2827
runs-on: ubuntu-latest
2928
steps:
3029
- name: Checkout code
31-
uses: runloopai/checkout@main
30+
uses: actions/checkout@v4
3231

3332
- name: Setup Node.js
34-
uses: runloopai/setup-node@main
33+
uses: actions/setup-node@v4
3534
with:
3635
node-version: "20"
3736
cache: "npm"
@@ -46,10 +45,10 @@ jobs:
4645
runs-on: ubuntu-latest
4746
steps:
4847
- name: Checkout code
49-
uses: runloopai/checkout@main
48+
uses: actions/checkout@v4
5049

5150
- name: Setup Node.js
52-
uses: runloopai/setup-node@main
51+
uses: actions/setup-node@v4
5352
with:
5453
node-version: "20"
5554
cache: "npm"
@@ -65,10 +64,10 @@ jobs:
6564
needs: build
6665
steps:
6766
- name: Checkout code
68-
uses: runloopai/checkout@main
67+
uses: actions/checkout@v4
6968

7069
- name: Setup Node.js
71-
uses: runloopai/setup-node@main
70+
uses: actions/setup-node@v4
7271
with:
7372
node-version: "20"
7473
cache: "npm"

‎.github/workflows/release.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ jobs:
4646
run: npm run build
4747

4848
- name: Publish to npm
49-
run: NPM_CONFIG_PROVENANCE=false npm publish # remove prominance disable when we open source this package
49+
run: npm publish

‎.gitignore‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
node_modules/
2+
.vscode
23
dist/
34
*.log
45
.DS_Store
56
.env
67
coverage
7-
*.mcpb
8+
*.mcpb

‎.husky/pre-push‎

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Pre-push hook to ensure code quality and docs are up to date
2+
# This hook runs format:check, lint, and docs:commands
3+
4+
echo "Running format:check..."
5+
if ! npm run format:check; then
6+
echo ""
7+
echo "❌ Code formatting check failed"
8+
echo " Please run 'npm run format' to fix formatting issues"
9+
echo ""
10+
exit 1
11+
fi
12+
13+
echo "Running lint..."
14+
if ! npm run lint; then
15+
echo ""
16+
echo "❌ Linting failed"
17+
echo " Please run 'npm run lint:fix' to fix linting issues"
18+
echo ""
19+
exit 1
20+
fi
21+
22+
echo "Running docs:commands to ensure README.md is up to date..."
23+
24+
# Run the docs generation script
25+
npm run docs:commands
26+
27+
# Check if README.md has uncommitted changes
28+
if ! git diff --quiet README.md; then
29+
echo ""
30+
echo "❌ README.md has uncommitted changes after running docs:commands"
31+
echo " Please commit the updated README.md before pushing:"
32+
echo ""
33+
echo " git add README.md"
34+
echo " git commit -m 'docs: update command structure'"
35+
echo ""
36+
exit 1
37+
fi
38+
39+
# Check if README.md has staged but uncommitted changes
40+
if ! git diff --cached --quiet README.md 2>/dev/null; then
41+
echo ""
42+
echo "⚠️ README.md has staged changes that need to be committed"
43+
echo " Please commit the staged README.md before pushing"
44+
echo ""
45+
exit 1
46+
fi
47+
48+
echo "✅ README.md is up to date"
49+
exit 0

‎CLAUDE_SETUP.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -197,4 +197,4 @@ Claude will automatically use these tools when you ask questions about your Runl
197197

198198
---
199199

200-
**Need help?** Open an issue at https://github.com/runloop/rl-cli-node/issues
200+
**Need help?** Open an issue at https://github.com/runloopai/rl-cli/issues

‎CODE_OF_CONDUCT.md‎

Lines changed: 129 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,129 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, religion, or sexual identity
10+
and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the
26+
overall community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or
31+
advances of any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email
35+
address, without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
**opensource@runloop.ai**.
64+
65+
All complaints will be reviewed and investigated promptly and fairly.
66+
67+
All community leaders are obligated to respect the privacy and security of the
68+
reporter of any incident.
69+
70+
## Enforcement Guidelines
71+
72+
Community leaders will follow these Community Impact Guidelines in determining
73+
the consequences for any action they deem in violation of this Code of Conduct:
74+
75+
### 1. Correction
76+
77+
**Community Impact**: Use of inappropriate language or other behavior deemed
78+
unprofessional or unwelcome in the community.
79+
80+
**Consequence**: A private, written warning from community leaders, providing
81+
clarity around the nature of the violation and an explanation of why the
82+
behavior was inappropriate. A public apology may be requested.
83+
84+
### 2. Warning
85+
86+
**Community Impact**: A violation through a single incident or series
87+
of actions.
88+
89+
**Consequence**: A warning with consequences for continued behavior. No
90+
interaction with the people involved, including unsolicited interaction with
91+
those enforcing the Code of Conduct, for a specified period of time. This
92+
includes avoiding interactions in community spaces as well as external channels
93+
like social media. Violating these terms may lead to a temporary or
94+
permanent ban.
95+
96+
### 3. Temporary Ban
97+
98+
**Community Impact**: A serious violation of community standards, including
99+
sustained inappropriate behavior.
100+
101+
**Consequence**: A temporary ban from any sort of interaction or public
102+
communication with the community for a specified period of time. No public or
103+
private interaction with the people involved, including unsolicited interaction
104+
with those enforcing the Code of Conduct, is allowed during this period.
105+
Violating these terms may lead to a permanent ban.
106+
107+
### 4. Permanent Ban
108+
109+
**Community Impact**: Demonstrating a pattern of violation of community
110+
standards, including sustained inappropriate behavior, harassment of an
111+
individual, or aggression toward or disparagement of classes of individuals.
112+
113+
**Consequence**: A permanent ban from any sort of public interaction within
114+
the community.
115+
116+
## Attribution
117+
118+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
119+
version 2.0, available at
120+
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
121+
122+
Community Impact Guidelines were inspired by [Mozilla's code of conduct
123+
enforcement ladder](https://github.com/mozilla/diversity).
124+
125+
[homepage]: https://www.contributor-covenant.org
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
https://www.contributor-covenant.org/faq. Translations are available at
129+
https://www.contributor-covenant.org/translations.

0 commit comments

Comments
 (0)