A local-first private AI assistant for everyday use. Runs on-device models with encrypted P2P sync, and supports sharing chats publicly on ATProto.
1## Contributing to Tiles
2
3Thanks for your interest in contributing to Tiles. We welcome contributions of all kinds, including code, documentation, design, and discussion.
4
5To understand the project goals and architecture, start with:
6- Install [Tiles CLI](https://tiles.run/download) and try it out.
7- Read the announcement: [Introducing Tiles Public Alpha](https://tiles.run/blog/introducing-tiles-public-alpha)
8- Explore the documentation: [Tiles Book](https://tiles.run/book)
9- Join or contribute to the conversation: [Tiles RFC Discussions](https://github.com/orgs/tilesprivacy/discussions)
10
11### Getting Started
12
13Instructions for setting up a local development environment and building the project are available in [HACKING.md](HACKING.md). Please follow those steps before submitting any code changes.
14
15### How to Contribute
16
17You can contribute in several ways:
18- Report bugs or request features by opening an issue
19- Improve documentation or examples
20- Submit pull requests for bug fixes, refactors, or new features
21- Open an RFC discussion for proposals that introduce major features, architectural changes, or significant new areas of functionality
22
23Before starting work, check the existing issues to avoid duplication and to align with current priorities. If you plan to work on a larger change, open an issue or discussion first to confirm scope and approach.
24
25### Pull Request Guidelines
26
27When submitting a pull request:
28- Keep changes focused and scoped to a single concern
29- Follow existing code style and conventions
30- Include clear commit messages and a concise PR description
31- Reference relevant issues where applicable
32- Ensure all checks and tests pass
33
34New inference backends, memory models, and improvements aligned with the roadmap are especially welcome.
35
36### Using AI Agents
37
38This project has specific guidelines for using AI tools when contributing. **AI-generated pull requests are not accepted**—AI tools may only be used in an assistive capacity.
39
40For detailed information about:
41- What AI assistance is permitted
42- How to properly disclose AI usage
43- Guidelines for AI agents and contributors
44
45Please see [AGENTS.md](AGENTS.md) before using AI tools in your contributions.
46
47### Communication and Support
48
49If you have questions or want to discuss ideas, you can reach the team and community via:
50- Discord: https://go.tiles.run/discord
51- Email: [hello@tiles.run](mailto:hello@tiles.run)
52
53### Code of Conduct
54
55By participating in this project, you agree to follow the project’s [Code of Conduct](CODE_OF_CONDUCT.md). Be respectful, constructive, and collaborative in all interactions.
56
57We appreciate your time and effort in helping build Tiles.