Macro is a unified workspace for teams: email, chat, docs, tasks, agents, calls, and CRM — @-linked together with shared AI memory.
TypeScript agentaiai-agentsall-in-onecrmcrm-systememaillinearmcpmessagingnotesnotionofficerustslackslack-alternativestartupstartup-toolstypescriptworkspace
feat: contribution guidelines (#4755)
Eric Hayes7ec14cf71d82
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdnew file mode 100644index 0000000000..1bf29ccf8d--- /dev/null+++ b/CONTRIBUTING.md@@ -0,0 +1,60 @@+# Contributing to Macro++Thanks for your interest in contributing! Macro is fully open source under the+[AGPLv3](LICENSE.txt), and we welcome outside contributions. This guide covers+how to get a change from idea to merged PR.++## Start with an issue++Open an issue before putting up a PR. This applies to both features and fixes. It lets us confirm the change is wanted and agree on an approach before you invest time into it. PRs that show up without a linked issue may be closed.++## AI-assisted contributions++Useful contributions require human effort. You may use whatever tools best+serve you including AI tools, but if you don't understand the work you're+doing it's probably not useful.++You should:+- Understand the changes and decisions you made well enough to answer questions in review.+- See your change working in a local development environment++Unreviewed AI output submitted as-is wastes reviewer time and will be closed.++## Conventions++We use semantic (Conventional Commits) naming for branches and PR titles:++```+feat(chat): add dev observability+fix(email): handle empty thread subjects+```++- **PR title:** `type(scope): short description` this becomes the commit+ message on merge, so make it accurate.+- **Branch name:** same idea, slash-separated, e.g. `feat/chat-dev-observability`.++Common types: `feat`, `fix`, `chore`++## PR bodies++Keep PR bodies concise and write them yourself. A few sentences covering what+changed and why, a link to the issue, and anything a reviewer needs to know.+No generated boilerplate, no exhaustive file-by-file change lists.++## Development setup++See [docs/RUNNING_LOCALLY.md](docs/RUNNING_LOCALLY.md) for running the full app+locally. The short version: use the Nix shell, then `just run_local`.++## Before you push++- Follow the [style guide](docs/STYLE_GUIDE.md).+- Format and lint: `cargo fmt` and `just clippy` for Rust changes.+- Run the tests for the crates you touched: `cargo test -p <crate>`.+- If you changed SQL queries or migrations, run `just prepare_db` from the+ repository root to refresh the sqlx cache.++## License++By contributing, you agree that your contributions will be licensed under the+[AGPLv3](LICENSE.txt), the same license that covers the project.diff --git a/README.md b/README.mdindex 74a98f0075..c744ddc70c 100644--- a/README.md+++ b/README.md@@ -15,7 +15,7 @@·<a href="mailto:[email protected]">Feature requests</a>·- <a href="mailto:[email protected]">Contribute</a>+ <a href="CONTRIBUTING.md">Contribute</a>·<a href="mailto:[email protected]">Hiring</a></p>@@ -103,7 +103,7 @@ You can self-host Macro under the terms of the AGPLv3; the [FAQ](https://docs.maHave an idea, want to contribute, or want to work on Macro?- Feature requests: [[email protected]](mailto:[email protected])-- Contributions: open a PR, or email [[email protected]](mailto:[email protected]) if you're not sure where to start+- Contributions: see our [contribution guidelines](CONTRIBUTING.md)- Hiring: [[email protected]](mailto:[email protected])<div align="center">