Contributing to Auto-claude-code-research-in-sleep (ARIS)

English | 中文版

Thank you for your interest in contributing to ARIS! This document provides guidelines and instructions for contributing.

Ways to Contribute

• Report bugs or issues
• Suggest new features or skills
• Improve documentation
• Add translations
• Share your use cases and feedback

Getting Started

1. Fork the repository
2. Clone your fork:

   git clone https://github.com/YOUR_USERNAME/Auto-claude-code-research-in-sleep.git
   cd Auto-claude-code-research-in-sleep

3. Create a branch for your changes:

   git checkout -b your-feature-name

Development

Skill Development

Skills are Markdown files located in skills/. Each skill has:

• Frontmatter: YAML metadata (name, description, allowed-tools)
• Content: The skill instructions

Example skill structure:

---
name: my-skill
description: What this skill does
argument-hint: [optional-argument-hint]
allowed-tools: Read, Write, Bash(*)
---

# Skill Title

Instructions here...

Testing Your Changes

Before submitting:

1. Install your modified skill: cp -r skills/your-skill ~/.claude/skills/
2. Test in Claude Code: /your-skill test argument
3. Verify the skill works as expected

Pull Request Process

1. Make sure your changes are well-documented
2. Update README.md if you add new skills or features
3. Keep PRs focused on a single change
4. Write clear commit messages

PR Checklist

• Code follows the project style
• Documentation is updated (if applicable)
• Changes are tested locally

Code of Conduct

• Be respectful and inclusive
• Focus on constructive feedback
• Help others learn and grow

Questions?

Feel free to open an issue for any questions or join our WeChat group (QR code in README).

License

By contributing, you agree that your contributions will be licensed under the MIT License.