Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.8 KB
Raw

Contributing to Facade Code

Thank you for helping. Facade Code is developed in the open at github.com/y5ez3g/facadecode.

Bugs and ideas

Open an issue; Help > Report Issue opens a new one with your version filled in. Please search the existing issues first, and for a bug, say:

  • what you did, what you expected, and what happened instead;
  • the version, from Help > About, and your operating system;
  • for an agent problem, which agent CLI and which version.

Security vulnerabilities are not reported in issues; see SECURITY.md.

Code

How this repository works is in docs/ide/ENGINEERING.md: setting up a build, the commands that check a change, and the rules below in full. IDE source is in ide/; open that folder and run its development commands there. The standalone extension is in extension/, with its own AGENTS.md, and its specification is in docs/extension/. Product documentation is shared under docs/.

  • Branch from main as feature/<number>-<name>.
  • Merge, never rebase: a feature lands on main with --no-ff, after review.
  • Keep Facade Code's files together, and in VS Code's files add optional hooks rather than rewriting their logic, so that merging a newer VS Code stays cheap.
  • Every feature has a switch, and off means stock VS Code.
  • Every change lands with tests.
  • English everywhere: documents, comments and commit messages.

What a feature is meant to do is in docs/ide/. For a change to behavior, start from the spec, or open an issue to discuss it first.

License

By contributing, you agree that your contributions are licensed under the project's MIT license.