Files
n8n-AI-Multiple-Agent-Team/CONTRIBUTING.md

3.2 KiB
Raw Blame History

Contributing to n8n-Homelab-CTO-Agent-Team

Thank you for your interest in contributing! This project thrives on community collaboration. Whether you're fixing bugs, improving documentation, or sharing workflow examples, your contributions make this project better for everyone.

Types of Contributions

We welcome 5 types of contributions, regardless of your technical expertise:

1. Bug Reports

Help us identify and fix issues by submitting detailed bug reports.

Bug Report Template:

**Description**: Brief summary of the issue

**Steps to Reproduce**:
1. Step one
2. Step two
3. Step three

**Expected Behavior**: What should happen

**Actual Behavior**: What actually happens

**Environment**:
- n8n Version:
- OS:
- LLM Provider:

**Workflow Export**: (if applicable, sanitize credentials)

**Screenshots/Logs**: (if relevant)

2. Feature Requests

Share your ideas for new features or improvements.

Feature Request Template:

**Problem**: What problem does this solve?

**Proposed Solution**: Your idea for solving it

**Alternatives Considered**: Other approaches you thought of

**Use Case**: How you would use this feature

**Priority**: Low / Medium / High

3. Documentation Improvements

  • Fix typos and grammar
  • Add clarifications
  • Expand examples
  • Translate to other languages
  • Create video tutorials

4. Workflow Examples

  • Share your agent configurations
  • Submit service integration examples
  • Provide production-tested patterns
  • Document edge cases and solutions

5. Code Contributions

  • Bug fixes
  • Feature implementations
  • Test coverage improvements
  • Performance optimizations

Pull Request Process

Step 1: Fork the Repository

git clone https://github.com/ambicuity/n8n-AI-Multiple-Agent-Team.git
cd n8n-AI-Multiple-Agent-Team
git checkout -b feature/your-feature-name

Step 2: Make Changes

  • Follow existing code/documentation style
  • Test your changes thoroughly
  • Add examples if introducing new concepts

Step 3: Commit Your Changes

git add .
git commit -m "Add: Brief description of change"

Commit Message Format:

  • Add: New features or content
  • Fix: Bug fixes
  • Update: Changes to existing content
  • Remove: Deletions

Step 4: Submit Pull Request

  • Provide clear description
  • Reference related issues
  • Explain testing performed
  • Request review

Code of Conduct

This project follows standard open-source community guidelines:

  • Be respectful and inclusive
  • Provide constructive feedback
  • Accept constructive criticism gracefully
  • Focus on what's best for the community
  • Show empathy toward other community members

Before Submitting

Please ensure your contribution:

  1. Follows existing patterns and style
  2. Is tested (if code changes)
  3. Includes documentation (if new features)
  4. Sanitizes any credentials in examples
  5. References related issues (if applicable)

Questions?

If you're unsure about anything:

Thank you for helping make this project better!