From 73ad063b0a07b1367efa20a761b36b2f706baaf9 Mon Sep 17 00:00:00 2001 From: Owain_X <930836+ryanpq@users.noreply.github.com> Date: Fri, 19 Jun 2026 14:04:08 -0500 Subject: [PATCH] CONTRIBUTING updates MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Updated default branch references from `master` to `main`. - Added a “Before You Start” section to clarify when contributors should open a pull request directly versus opening an issue first. - Added guidance that documentation contributions are welcome, including setup clarification, examples, troubleshooting notes, stale command/link fixes, and task/evaluation documentation. - Added a “Security-Sensitive Changes” section for contributions involving sandboxing, subprocess execution, environment handling, task data access, or agent permissions. - Linked security-sensitive contribution guidance to `SECURITY.md`. --- CONTRIBUTING.md | 24 ++++++++++++++++++++++-- 1 file changed, 22 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index da4a48a..bbb6e0c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,6 +2,15 @@ Thank you for your interest in contributing to SIA (Self-Improving AI). This document provides guidelines for contributing to the project. +## Before You Start + +For small documentation fixes, typo fixes, and clearly scoped bug fixes, feel free to open a pull request directly. + +For larger changes, new features, new tasks, or behavior changes, please open an issue first so maintainers can discuss the approach before you invest significant time. + +Documentation contributions are welcome. Useful documentation changes include clarifying setup or usage instructions, improving examples, adding troubleshooting notes for common errors, correcting stale links or commands, and clarifying task authoring or evaluation behavior. + + ## How to Contribute ### Reporting Bugs @@ -25,11 +34,11 @@ Have an idea for a new feature or improvement? [Open an issue](https://github.co ### Submitting Changes 1. Fork the repository -2. Create a branch from `master` (`git checkout -b my-change`) +2. Create a branch from `main` (`git checkout -b my-change`) 3. Make your changes 4. Run the checks (see below) 5. Commit with a clear message describing the change -6. Push to your fork and open a pull request against `master` +6. Push to your fork and open a pull request against `main` ## Development Setup @@ -71,6 +80,17 @@ ruff check --fix sia/ tests/ ruff format sia/ tests/ ``` +## Security-Sensitive Changes + +SIA can execute agent-generated code. Changes to sandboxing, subprocess execution, environment-variable handling, task data access, or agent permissions should be treated as security-sensitive. + +For these changes: + +- Read [SECURITY.md](SECURITY.md) before starting. +- Prefer safer defaults for untrusted tasks and models. +- Do not log API keys, environment variables, private task data, or generated secrets. +- Explain the security impact in your pull request. + ## Adding a New Task To add a new task for SIA to work on, create the following structure: