Skip to content

Commit f73ce32

Browse files
rubenmarcusrubenmarcus
authored
Merge pull request #57 from rubenmarcus/label
feat: add ralph-ideas integration and configurable default issues repo
2 parents 82cb05b + 7d00f8b commit f73ce32

File tree

11 files changed

+414
-6
lines changed

11 files changed

+414
-6
lines changed

‎docs/docs/cli/config.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,9 @@ ralph-starter config set apiKey sk-ant-xxxx
5454
ralph-starter config set linear.apiKey lin_api_xxxx
5555
ralph-starter config set notion.token secret_xxxx
5656
ralph-starter config set github.token ghp_xxxx
57+
58+
# Set defaults
59+
ralph-starter config set github.defaultIssuesRepo owner/repo
5760
```
5861

5962
### Delete Value
@@ -70,6 +73,7 @@ ralph-starter config delete linear.apiKey
7073
| `linear.apiKey` | Linear API key |
7174
| `notion.token` | Notion integration token |
7275
| `github.token` | GitHub personal access token |
76+
| `github.defaultIssuesRepo` | Default repo for `--issue` without `--project` |
7377

7478
## Storage Location
7579

‎docs/docs/community/changelog.md‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
---
2+
sidebar_position: 2
3+
title: Changelog
4+
description: Release notes and version history for ralph-starter
5+
---
6+
7+
# Changelog
8+
9+
All notable changes to ralph-starter are documented here.
10+
11+
## [Unreleased]
12+
13+
### Planned
14+
- Interactive wizard mode improvements
15+
- Additional input source integrations
16+
- Template marketplace
17+
18+
---
19+
20+
## [0.1.x] - Initial Release
21+
22+
### Added
23+
- Core CLI with `run`, `init`, `plan`, `config`, and `source` commands
24+
- GitHub integration for fetching issues and PRs
25+
- Linear integration for fetching issues
26+
- Notion integration for fetching pages
27+
- Interactive wizard with idea mode
28+
- MCP server integration for Claude Desktop
29+
- Ralph Playbook support for custom configurations
30+
- Git automation for commits and PRs
31+
- Validation system for specs
32+
33+
### Features
34+
- **Multi-source support**: Fetch specs from GitHub, Linear, or Notion
35+
- **Autonomous coding loops**: Let AI agents build from specs
36+
- **Interactive wizard**: Step-by-step project setup
37+
- **MCP integration**: Use with Claude Desktop
38+
39+
---
40+
41+
## Version History
42+
43+
For the complete version history and release notes, see:
44+
45+
- [GitHub Releases](https://github.com/rubenmarcus/ralph-starter/releases)
46+
- [npm Package History](https://www.npmjs.com/package/ralph-starter?activeTab=versions)
47+
48+
## Upgrade Guide
49+
50+
### Upgrading to latest
51+
52+
```bash
53+
npm install -g ralph-starter@latest
54+
# or
55+
pnpm add -g ralph-starter@latest
56+
```
57+
58+
### Check current version
59+
60+
```bash
61+
ralph-starter --version
62+
```
63+
64+
## Contributing
65+
66+
Found a bug or want to contribute?
67+
68+
- [Report Issues](https://github.com/rubenmarcus/ralph-starter/issues)
69+
- [Submit Ideas](https://github.com/rubenmarcus/ralph-ideas/issues)
70+
- [View Source](https://github.com/rubenmarcus/ralph-starter)

‎docs/docs/community/contributing.md‎

Lines changed: 158 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,158 @@
1+
---
2+
sidebar_position: 3
3+
title: Contributing
4+
description: How to contribute to ralph-starter
5+
---
6+
7+
# Contributing
8+
9+
Thank you for your interest in contributing to ralph-starter! This guide will help you get started.
10+
11+
## Ways to Contribute
12+
13+
### Report Bugs
14+
15+
Found a bug? Please report it on [GitHub Issues](https://github.com/rubenmarcus/ralph-starter/issues).
16+
17+
When reporting bugs, please include:
18+
- ralph-starter version (`ralph-starter --version`)
19+
- Node.js version (`node --version`)
20+
- Operating system
21+
- Steps to reproduce
22+
- Expected vs actual behavior
23+
- Error messages or logs
24+
25+
### Submit Ideas
26+
27+
Have a feature idea? Submit it to [ralph-ideas](https://github.com/rubenmarcus/ralph-ideas/issues).
28+
29+
Good idea submissions include:
30+
- Clear description of the feature
31+
- Use case / problem it solves
32+
- Suggested implementation (optional)
33+
- Examples from other tools (optional)
34+
35+
### Contribute Code
36+
37+
1. **Fork the repository**
38+
```bash
39+
gh repo fork rubenmarcus/ralph-starter
40+
```
41+
42+
2. **Clone your fork**
43+
```bash
44+
git clone https://github.com/YOUR_USERNAME/ralph-starter
45+
cd ralph-starter
46+
```
47+
48+
3. **Install dependencies**
49+
```bash
50+
pnpm install
51+
```
52+
53+
4. **Create a feature branch**
54+
```bash
55+
git checkout -b feature/your-feature-name
56+
```
57+
58+
5. **Make your changes**
59+
- Follow the existing code style
60+
- Add tests for new functionality
61+
- Update documentation if needed
62+
63+
6. **Run tests**
64+
```bash
65+
pnpm test
66+
```
67+
68+
7. **Commit your changes**
69+
```bash
70+
git commit -m "feat: add your feature description"
71+
```
72+
73+
8. **Push and create a PR**
74+
```bash
75+
git push origin feature/your-feature-name
76+
gh pr create
77+
```
78+
79+
## Development Setup
80+
81+
### Prerequisites
82+
83+
- Node.js 18+
84+
- pnpm
85+
- Git
86+
87+
### Project Structure
88+
89+
```
90+
ralph-starter/
91+
├── src/ # Source code
92+
│ ├── cli/ # CLI commands
93+
│ ├── sources/ # Input source integrations
94+
│ ├── core/ # Core functionality
95+
│ └── utils/ # Utility functions
96+
├── docs/ # Documentation (Docusaurus)
97+
├── tests/ # Test files
98+
└── package.json
99+
```
100+
101+
### Running Locally
102+
103+
```bash
104+
# Build the project
105+
pnpm build
106+
107+
# Run in development
108+
pnpm dev
109+
110+
# Run tests
111+
pnpm test
112+
113+
# Run linting
114+
pnpm lint
115+
```
116+
117+
## Code Style
118+
119+
- Use TypeScript
120+
- Follow existing patterns in the codebase
121+
- Use meaningful variable and function names
122+
- Add JSDoc comments for public APIs
123+
- Keep functions small and focused
124+
125+
## Commit Messages
126+
127+
We follow [Conventional Commits](https://www.conventionalcommits.org/):
128+
129+
- `feat:` New feature
130+
- `fix:` Bug fix
131+
- `docs:` Documentation changes
132+
- `chore:` Maintenance tasks
133+
- `refactor:` Code refactoring
134+
- `test:` Adding or updating tests
135+
136+
Examples:
137+
```
138+
feat: add Jira integration
139+
fix: resolve GitHub auth token refresh issue
140+
docs: update installation guide
141+
```
142+
143+
## Pull Request Guidelines
144+
145+
- Keep PRs focused on a single change
146+
- Include tests for new functionality
147+
- Update documentation if needed
148+
- Link to related issues
149+
- Respond to review feedback promptly
150+
151+
## Questions?
152+
153+
- [GitHub Discussions](https://github.com/rubenmarcus/ralph-starter/discussions)
154+
- [Open an Issue](https://github.com/rubenmarcus/ralph-starter/issues)
155+
156+
---
157+
158+
Thank you for contributing to ralph-starter!

‎docs/docs/community/ideas.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
---
2+
sidebar_position: 1
3+
title: Ideas & Roadmap
4+
description: Feature ideas and development roadmap for ralph-starter
5+
---
6+
7+
# Ideas & Roadmap
8+
9+
Browse and contribute to the future of ralph-starter. All ideas and feature requests are tracked in the [ralph-ideas](https://github.com/rubenmarcus/ralph-ideas) repository.
10+
11+
## Quick Links
12+
13+
- [View All Ideas](https://github.com/rubenmarcus/ralph-ideas/issues)
14+
- [Submit New Idea](https://github.com/rubenmarcus/ralph-ideas/issues/new)
15+
- [P1 - Critical Priority](https://github.com/rubenmarcus/ralph-ideas/labels/P1)
16+
- [P2 - High Priority](https://github.com/rubenmarcus/ralph-ideas/labels/P2)
17+
- [P3 - Medium Priority](https://github.com/rubenmarcus/ralph-ideas/labels/P3)
18+
19+
## Categories
20+
21+
### Templates
22+
23+
Pre-built project starters for various use cases:
24+
25+
| Template | Priority | Status |
26+
|----------|----------|--------|
27+
| [Next.js SaaS Starter](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+saas) | P1 | Planned |
28+
| [Marketing Landing Page](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+landing) | P1 | Planned |
29+
| [GitHub Actions CI/CD](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+actions) | P1 | Planned |
30+
| [Express.js REST API](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+express) | P2 | Planned |
31+
| [Chrome Extension](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+extension) | P2 | Planned |
32+
| [CLI Tool](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Atemplates+cli) | P2 | Planned |
33+
34+
[View all templates →](https://github.com/rubenmarcus/ralph-ideas/labels/templates)
35+
36+
### Automation
37+
38+
Tools to streamline development workflows:
39+
40+
| Feature | Priority | Status |
41+
|---------|----------|--------|
42+
| [Auto PR Review Bot](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+PR+review) | P1 | Planned |
43+
| [Auto Release Notes](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+release) | P1 | Planned |
44+
| [Auto Issue Triage](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+triage) | P2 | Planned |
45+
| [Auto Dependency Updates](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+dependency) | P2 | Planned |
46+
| [Auto Documentation](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+docs) | P2 | Planned |
47+
| [Auto Test Generator](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Aautomation+test) | P2 | Planned |
48+
49+
[View all automation ideas →](https://github.com/rubenmarcus/ralph-ideas/labels/automation)
50+
51+
### Blockchain & Web3
52+
53+
Blockchain and decentralized application templates:
54+
55+
| Template | Priority | Status |
56+
|----------|----------|--------|
57+
| [Web3 dApp Frontend](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+dapp) | P2 | Planned |
58+
| [ERC-20 Token](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+erc20) | P3 | Backlog |
59+
| [NFT Collection](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+nft) | P3 | Backlog |
60+
| [DeFi Staking Contract](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ablockchain+defi) | P3 | Backlog |
61+
62+
[View all blockchain ideas →](https://github.com/rubenmarcus/ralph-ideas/labels/blockchain)
63+
64+
### DevOps & Infrastructure
65+
66+
CI/CD and infrastructure templates:
67+
68+
| Template | Priority | Status |
69+
|----------|----------|--------|
70+
| [Docker Compose Dev Environment](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+docker) | P2 | Planned |
71+
| [Kubernetes + Helm Charts](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+kubernetes) | P3 | Backlog |
72+
| [Terraform Infrastructure](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+terraform) | P3 | Backlog |
73+
| [Monitoring Stack](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Adevops+monitoring) | P3 | Backlog |
74+
75+
[View all DevOps ideas →](https://github.com/rubenmarcus/ralph-ideas/labels/devops)
76+
77+
### Scripts & Utilities
78+
79+
Helpful scripts and developer tools:
80+
81+
| Utility | Priority | Status |
82+
|---------|----------|--------|
83+
| [Git Hooks Setup](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+hooks) | P2 | Planned |
84+
| [Database Seeder](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+seeder) | P2 | Planned |
85+
| [OpenAPI Client Generator](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+openapi) | P3 | Backlog |
86+
| [Environment Validator](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+env) | P3 | Backlog |
87+
| [Project Health Check](https://github.com/rubenmarcus/ralph-ideas/issues?q=label%3Ascripts+health) | P3 | Backlog |
88+
89+
[View all scripts & utilities →](https://github.com/rubenmarcus/ralph-ideas/labels/scripts)
90+
91+
## Integrations
92+
93+
Feature requests for ralph-starter core:
94+
95+
| Feature | Priority | Status |
96+
|---------|----------|--------|
97+
| [Slack Integration](https://github.com/rubenmarcus/ralph-ideas/issues?q=slack) | Enhancement | Planned |
98+
| [Figma Integration](https://github.com/rubenmarcus/ralph-ideas/issues?q=figma) | Enhancement | Planned |
99+
| [Debug/Interactive Mode](https://github.com/rubenmarcus/ralph-ideas/issues?q=debug+mode) | Enhancement | Planned |
100+
| [Swarm Mode](https://github.com/rubenmarcus/ralph-ideas/issues?q=swarm) | Enhancement | Planned |
101+
| [GitHub Action](https://github.com/rubenmarcus/ralph-ideas/issues?q=github+action) | Enhancement | Planned |
102+
| [Ollama Support](https://github.com/rubenmarcus/ralph-ideas/issues?q=ollama) | Enhancement | Planned |
103+
| [Google Gemini Provider](https://github.com/rubenmarcus/ralph-ideas/issues?q=gemini) | Enhancement | Planned |
104+
105+
## Contributing Ideas
106+
107+
Have a feature request or idea? We'd love to hear it!
108+
109+
1. **Check existing issues** - Search [ralph-ideas](https://github.com/rubenmarcus/ralph-ideas/issues) to avoid duplicates
110+
2. **Create a new issue** - Use a clear, descriptive title
111+
3. **Add labels** - Use appropriate priority (P1/P2/P3) and category labels
112+
4. **Describe the use case** - Explain why this feature would be useful
113+
114+
### Priority Guidelines
115+
116+
- **P1 (Critical)**: Core features that many users need
117+
- **P2 (High)**: Important features that enhance the experience
118+
- **P3 (Medium)**: Nice-to-have features for specific use cases

0 commit comments

Comments
 (0)