Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
139 lines (95 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

139 lines (95 loc) · 3.27 KB

CONTRIBUTING.md

Thank you for contributing to Velt Agent Skills! Here's how to get started:

1. Getting Started | 2. Issues | 3. Pull Requests | 4. Contributing New Rules | 5. Creating a New Skill

Getting Started

To ensure a positive and inclusive environment, please be respectful and constructive in all contributions.

Issues

If you find a typo, have a suggestion for a new skill/rule, or want to improve existing skills/rules, please create an Issue.

  • Please search existing Issues before creating a new one.
  • Please include a clear description of the problem or suggestion.
  • Tag your issue appropriately (e.g., bug, question, enhancement, new-rule, new-skill, documentation).

Pull Requests

We actively welcome your Pull Requests! Here's what to keep in mind:

  • If you're fixing an Issue, make sure someone else hasn't already created a PR for it. Link your PR to the related Issue(s).
  • We will always try to accept the first viable PR that resolves the Issue.
  • If you're new, we encourage you to take a look at issues tagged with good first issue.
  • If you're proposing a significant new skill or major changes, please open a Discussion first to gather feedback before investing time in implementation.

Pre-Flight Checks

Before submitting your PR, please run these checks:

npm run validate  # Check rule format and structure
npm run build     # Generate AGENTS.md from rules

Both commands must complete successfully.

Contributing New Rules

To add a rule to an existing skill:

  1. Navigate to skills/{skill-name}/rules/{category}/
  2. Copy ../_template.md to {prefix}-{your-rule-name}.md
  3. Fill in the frontmatter (title, impact, impactDescription, tags)
  4. Write explanation and examples (Incorrect/Correct)
  5. Add verification checklist and source pointer
  6. Run validation and build:
npm run validate
npm run build

Creating a New Skill

To create an entirely new skill:

1. Create the directory structure

mkdir -p skills/my-skill/rules

2. Create metadata.json

{
  "version": "1.0.0",
  "organization": "Your Org",
  "date": "January 2026",
  "abstract": "Brief description of this skill."
}

3. Create SKILL.md

---
name: my-skill
description: One sentence describing when to use this skill.
---

# My Skill

Description and category tables.

4. Create rules/_sections.md

## 1. First Category (first/)

**Impact:** HIGH
**Description:** What this category covers.

**Rules:**
- `first-example-rule` - Description

## 2. Second Category (second/)

**Impact:** MEDIUM
**Description:** What this category covers.

5. Create category folders and rule files

mkdir skills/my-skill/rules/first
# Create rules/first/first-example-rule.md

Name files as {prefix}-{rule-name}.md where prefix matches the category.

6. Build

npm run build

The build system auto-discovers skills. No configuration needed.

Questions or Feedback?

  • Open an Issue for bugs or suggestions
  • Check existing Issues before creating new ones

License

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