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
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: Bug Report
about: Create a report to help us improve
title: '[BUG] '
labels: bug
assignees: ''
---

## Description

A clear and concise description of what the bug is.

## Steps to Reproduce

1. Run command '...'
2. See error

## Expected Behavior

A clear and concise description of what you expected to happen.

## Actual Behavior

A clear and concise description of what actually happened.

## Environment

- OS: [e.g., macOS 14.0, Ubuntu 22.04, Windows 11]
- Node.js version: [e.g., 20.10.0]
- CLI version: [e.g., 0.7.0]
- Terminal: [e.g., iTerm2, Terminal.app, Windows Terminal]

## Additional Context

Add any other context about the problem here.

## Screenshots/Logs

If applicable, add screenshots or logs to help explain your problem.

```bash
# Paste relevant logs here
```
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature Request
about: Suggest an idea for this project
title: '[FEATURE] '
labels: enhancement
assignees: ''
---

## Problem Statement

A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

## Proposed Solution

A clear and concise description of what you want to happen.

## Alternatives Considered

A clear and concise description of any alternative solutions or features you've considered.

## Use Case

Describe the use case or scenario where this feature would be helpful.

## Additional Context

Add any other context, mockups, or examples about the feature request here.
53 changes: 53 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
## Description

<!-- Provide a brief description of your changes -->

**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.

## Type of Change

<!-- Mark the relevant option with an 'x' -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] Documentation update
- [ ] Code refactoring
- [ ] Performance improvement
- [ ] Test updates

## Related Issues

<!-- Link to related issues using #issue-number -->
Closes #

## Changes Made

<!-- Describe the changes in detail -->

## Testing

<!-- Describe how you tested your changes -->

- [ ] I have tested locally
- [ ] I have added/updated tests
- [ ] All existing tests pass

## Checklist

- [ ] My code follows the code style of this project
- [ ] I have performed a self-review of my own code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have updated the documentation accordingly
- [ ] My changes generate no new warnings
- [ ] I have added tests that prove my fix is effective or that my feature works
- [ ] New and existing unit tests pass locally with my changes
- [ ] Any dependent changes have been merged and published

## Screenshots (if applicable)

<!-- Add screenshots to help explain your changes -->

## Additional Notes

<!-- Any additional information that reviewers should know -->
17 changes: 8 additions & 9 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,17 @@ name: CI

on:
pull_request:
types: [opened, synchronize, reopened]
workflow_dispatch:

jobs:
format:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: runloopai/checkout@main
uses: actions/checkout@v4

- name: Setup Node.js
uses: runloopai/setup-node@main
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
Expand All @@ -28,10 +27,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: runloopai/checkout@main
uses: actions/checkout@v4

- name: Setup Node.js
uses: runloopai/setup-node@main
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
Expand All @@ -46,10 +45,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: runloopai/checkout@main
uses: actions/checkout@v4

- name: Setup Node.js
uses: runloopai/setup-node@main
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
Expand All @@ -65,10 +64,10 @@ jobs:
needs: build
steps:
- name: Checkout code
uses: runloopai/checkout@main
uses: actions/checkout@v4

- name: Setup Node.js
uses: runloopai/setup-node@main
uses: actions/setup-node@v4
with:
node-version: "20"
cache: "npm"
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,4 +46,4 @@ jobs:
run: npm run build

- name: Publish to npm
run: NPM_CONFIG_PROVENANCE=false npm publish # remove prominance disable when we open source this package
run: npm publish
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
node_modules/
.vscode
dist/
*.log
.DS_Store
.env
coverage
*.mcpb
*.mcpb
49 changes: 49 additions & 0 deletions .husky/pre-push
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
# Pre-push hook to ensure code quality and docs are up to date
# This hook runs format:check, lint, and docs:commands

echo "Running format:check..."
if ! npm run format:check; then
echo ""
echo "❌ Code formatting check failed"
echo " Please run 'npm run format' to fix formatting issues"
echo ""
exit 1
fi

echo "Running lint..."
if ! npm run lint; then
echo ""
echo "❌ Linting failed"
echo " Please run 'npm run lint:fix' to fix linting issues"
echo ""
exit 1
fi

echo "Running docs:commands to ensure README.md is up to date..."

# Run the docs generation script
npm run docs:commands

# Check if README.md has uncommitted changes
if ! git diff --quiet README.md; then
echo ""
echo "❌ README.md has uncommitted changes after running docs:commands"
echo " Please commit the updated README.md before pushing:"
echo ""
echo " git add README.md"
echo " git commit -m 'docs: update command structure'"
echo ""
exit 1
fi

# Check if README.md has staged but uncommitted changes
if ! git diff --cached --quiet README.md 2>/dev/null; then
echo ""
echo "⚠️ README.md has staged changes that need to be committed"
echo " Please commit the staged README.md before pushing"
echo ""
exit 1
fi

echo "✅ README.md is up to date"
exit 0
2 changes: 1 addition & 1 deletion CLAUDE_SETUP.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,4 +197,4 @@ Claude will automatically use these tools when you ask questions about your Runl

---

**Need help?** Open an issue at https://github.com/runloop/rl-cli-node/issues
**Need help?** Open an issue at https://github.com/runloopai/rl-cli/issues
129 changes: 129 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community 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, 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.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the
overall community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or
advances of any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email
address, without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
**opensource@runloop.ai**.

All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series
of actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or
permanent ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within
the community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.0, available at
https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.

Community Impact Guidelines were inspired by [Mozilla's code of conduct
enforcement ladder](https://github.com/mozilla/diversity).

[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see the FAQ at
https://www.contributor-covenant.org/faq. Translations are available at
https://www.contributor-covenant.org/translations.
Loading
Loading