Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
55 lines (35 loc) · 2.67 KB

CONTRIBUTING.md

File metadata and controls

55 lines (35 loc) · 2.67 KB

Contributing to this Project

First off, thank you for considering contributing to the Snowdream Tech AI IDE Template! It's people like you that make this template such a great foundational tool.

🤝 How to Contribute

We welcome contributions of all kinds, including bug fixes, new AI agent rules, documentation improvements, and CI/CD enhancements.

1. Setting Up Your Environment

Before submitting any changes, you must set up your local development environment to ensure your code matches our strict project standards:

  1. Install pre-commit: We rely heavily on pre-commit to catch linting, formatting, and security issues before they are committed.

    pip install pre-commit
pre-commit install --hook-type pre-commit --hook-type pre-merge-commit --hook-type commit-msg

  2. Verify Setup: Run make setup and make install to ensure all system and project dependencies are available, then run make lint to verify.

2. General Workflow

  1. Fork the repository on GitHub.
  2. Clone your fork locally.
  3. Branch from main to a descriptively named branch (e.g., feat/add-new-ai-rule, fix/ci-memory-leak).
  4. Develop your feature or fix.
  5. Commit your changes following our Conventional Commits standards. We highly recommend using our interactive Commitizen CLI to automatically assemble your commit message format. Simply run make commit (or npm run commit) to launch the interactive prompt.
  6. Push to your fork.
  7. Submit a Pull Request (PR) against our main branch.

3. Developer Certificate of Origin (DCO)

To legally protect the repository, all commits must be signed off. This signifies that you have the right to submit the code you are contributing.

You can easily sign off your commits by using the -s or --signoff flag:

git commit -s -m "fix(script): resolve posix portability issue"

Tip: If you use make commit, you can add the signoff flag by configuring your system git globally: git config --global commit.gpgsign true or git config --global format.signOff true.

4. Code & Architecture Standards

Before submitting rules or code, you MUST read our internal architecture guides:

Any Pull Request that fails the mandatory CI workflow checks or violates the architectural standards will not be merged.

Thank you for helping us build the ultimate SSOT AI IDE Template!