Contributing to Bootspring

Thank you for your interest in contributing to Bootspring. This guide covers everything you need to know to contribute effectively.

Ways to Contribute#

---

Getting Started#

1. Fork the Repository#

2. Install Dependencies#

3. Set Up Development Environment#

4. Create a Branch#

---

Creating Custom Agents#

Agents are specialized AI personas that provide domain expertise.

Agent Structure#

Step 1: Create the Directory#

Step 2: Create context.md#

This is the core of your agent. It defines the agent's expertise and behavior.

Step 3: Register the Agent#

Add to bootspring.config.js:

Agent Guidelines#

1. Be specific - Focus on a well-defined domain
2. Be practical - Include actionable patterns and examples
3. Be comprehensive - Cover common scenarios thoroughly
4. Be opinionated - Recommend best practices, not just options
5. Include context - Explain the "why" behind recommendations

Example: Creating a GraphQL Expert Agent#

---

Creating Custom Patterns#

Patterns are production-ready code templates for common tasks.

Pattern Structure#

Pattern Template#

Pattern Guidelines#

1. Production-ready - Code should work out of the box
2. Well-documented - Explain what the code does
3. Tested - Include test examples
4. Configurable - Allow customization where appropriate
5. TypeScript-first - Use TypeScript with proper types

---

Creating Custom Skills#

Skills are reusable templates that generate code based on parameters.

Skill Structure#

Skill Guidelines#

1. Clear parameters - Document all inputs
2. Sensible defaults - Provide good default values
3. Multiple examples - Show various use cases
4. Error handling - Validate inputs

---

Code Style Guidelines#

TypeScript#

Naming Conventions#

Code Organization#

Documentation#

---

Submitting Pull Requests#

Before Submitting#

1. Run tests: npm test
2. Run linter: npm run lint
3. Build: npm run build
4. Update docs if needed

PR Guidelines#

1. Clear title - Describe what the PR does
2. Description - Explain the changes and why
3. Link issues - Reference related issues
4. Small PRs - Keep changes focused
5. Tests - Add tests for new functionality

Commit Messages#

Use conventional commits:

Important:

• Write clear, descriptive commit messages
• Keep commits atomic (one logical change per commit)
• Never add Co-Authored-By or AI attribution to commits
• Never commit secrets, API keys, or credentials

PR Template#

---

Development Workflow#

1. Sync with Upstream#

2. Make Changes#

3. Run Quality Checks#

4. Push and Create PR#

5. Address Review Feedback#

---

Testing#

Running Tests#

Writing Tests#

---

Getting Help#

Resources#

• GitHub Issues - Report bugs and request features
• Discussions - Ask questions and share ideas
• Documentation - Read the docs

Questions?#

If you're unsure about anything:

1. Check existing issues and discussions
2. Ask in GitHub Discussions
3. Open a draft PR for feedback

---

Recognition#

Contributors are recognized in:

• CONTRIBUTORS.md file
• Release notes
• Documentation credits

Thank you for contributing to Bootspring!

---

Related#

• All Agents - See existing agents for examples
• Skills Overview - Understand skill structure
• Code Patterns - Browse existing patterns
• CLI Reference - Command documentation