From c6d5678ec38cff3e35b4c30cc808a85d4cfe41f9 Mon Sep 17 00:00:00 2001 From: factory-ain3sh Date: Mon, 13 Apr 2026 01:27:53 +0000 Subject: [PATCH] docs: add MIT license and contributing guidelines Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug-or-improvement.md | 21 ++++++++ .github/ISSUE_TEMPLATE/skill-proposal.md | 25 ++++++++++ CONTRIBUTING.md | 51 ++++++++++++++++++++ LICENSE | 21 ++++++++ 4 files changed, 118 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-or-improvement.md create mode 100644 .github/ISSUE_TEMPLATE/skill-proposal.md create mode 100644 CONTRIBUTING.md create mode 100644 LICENSE diff --git a/.github/ISSUE_TEMPLATE/bug-or-improvement.md b/.github/ISSUE_TEMPLATE/bug-or-improvement.md new file mode 100644 index 0000000..c419b05 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-or-improvement.md @@ -0,0 +1,21 @@ +--- +name: Bug or improvement +about: Report an issue or suggest an improvement to an existing plugin +labels: bug +--- + +## Which plugin and skill? + + + +## What happened? + + + +## What did you expect? + + + +## Steps to reproduce + + diff --git a/.github/ISSUE_TEMPLATE/skill-proposal.md b/.github/ISSUE_TEMPLATE/skill-proposal.md new file mode 100644 index 0000000..44fa88f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/skill-proposal.md @@ -0,0 +1,25 @@ +--- +name: Skill proposal +about: Propose a new skill or command for an existing plugin +labels: proposal +--- + +## Which plugin? + + + +## What should the skill do? + + + +## Who benefits? + + + +## Why does it belong here? + + + +## Anything else? + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..52e27e4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,51 @@ +# Contributing + +## What's open to contributions + +| Plugin | Who can contribute | Process | +|--------|--------------------|---------| +| `core` | Factory employees only | Internal review | +| Everything else | Anyone | Open an issue first, then PR | + +## Before you start + +**Open an issue before writing code.** Describe what you want to change and why. This saves everyone time if the direction needs adjustment or the work is already planned. + +Small fixes (typos, broken links, clarifying a sentence) can go straight to a PR. + +## Standards + +**You must be willing to stand behind every line you push.** If you used AI tools to help write code, that's fine, but you are responsible for reviewing and understanding it. PRs with unreviewed generated output will be closed. + +**No promotions.** Plugins exist to give Droids useful capabilities, not to advertise products or services. Plugins that primarily serve to promote external software will be rejected. + +**Broadly useful.** This marketplace is for plugins that serve a wide range of users. If a plugin or feature only applies to a narrow workflow or a specific team's setup, it's better suited as a standalone plugin in your own repo. When proposing new plugins or significant additions, consider whether most Droid users would benefit. + +**Match existing conventions.** Read the plugin you're modifying before changing it. Follow the same file structure, naming, and style. When in doubt, look at how existing plugins handle it. + +## Submitting a PR + +1. Fork the repo and create a branch from `master`. +2. Make your changes. Keep the diff focused on one thing. +3. Test your changes locally by installing the plugin via the marketplace. +4. Open a PR with a clear description of what changed and why. + +## Plugin structure + +Every plugin must include a `.factory-plugin/plugin.json` manifest. See the [Factory plugin docs](https://docs.factory.ai/cli/configuration/plugins) for the full spec. + +``` +my-plugin/ +├── .factory-plugin/ +│ └── plugin.json +├── skills/ +│ └── my-skill/ +│ └── SKILL.md +├── commands/ +│ └── my-command.md +└── README.md +``` + +## License + +By contributing, you agree that your contributions will be licensed under the [MIT License](LICENSE). diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1580d5a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2026 Factory AI, Inc. + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE.