ros/spec-kit
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
919bda235588198b548e93a97fae4670314a8e57
spec-kit/CONTRIBUTING.md
Pengkui Luo 919bda2355 docs: fix grammar mistakes in markdown files
2025-09-17 20:36:30 -07:00

3.3 KiB
Raw Blame History

Contributing to Spec Kit

Hi there! We're thrilled that you'd like to contribute to Spec Kit. Contributions to this project are released to the public under the project's open source license.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Prerequisites for running and testing code

These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.

  1. Install Python 3.11+
  2. Install uv for package management
  3. Install Git
  4. Have an AI coding agent available: Claude Code, GitHub Copilot, Gemini CLI, or Qwen Code. We're working on adding support for other agents as well.

Submitting a pull request

Note

If your pull request introduces a large change that materially impacts the work of the CLI or the rest of the repository (e.g., you're introducing new templates, arguments, or otherwise major changes), make sure that it was discussed and agreed upon by the project maintainers. Pull requests with large changes that did not have a prior conversation and agreement will be closed.

  1. Fork and clone the repository
  2. Configure and install the dependencies: uv sync
  3. Make sure the CLI works on your machine: uv run specify --help
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure everything still works
  6. Test the CLI functionality with a sample project if relevant
  7. Push to your fork and submit a pull request
  8. Wait for your pull request to be reviewed and merged.

Here are a few things you can do that will increase the likelihood of your pull request being accepted:

  • Follow the project's coding conventions.
  • Write tests for new functionality.
  • Update documentation (README.md, spec-driven.md) if your changes affect user-facing features.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.
  • Test your changes with the Spec-Driven Development workflow to ensure compatibility.

Development workflow

When working on spec-kit:

  1. Test changes with the specify CLI commands (/specify, /plan, /tasks) in your coding agent of choice
  2. Verify templates are working correctly in templates/ directory
  3. Test script functionality in the scripts/ directory
  4. Ensure memory files (memory/constitution.md) are updated if major process changes are made

Resources