Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ assignees: ''
<!-- A clear and concise description of the bug -->

## Component
- [ ] pixles-android
- [ ] pixles-api
- [ ] pixles-cli
- [ ] pixles-core-rust
- [ ] pixles-desktop
- [ ] pixles-docs
- [ ] pixles-media
- [ ] pixles-swift
- [ ] pixles-web
- [ ] capsule-android
- [ ] capsule-api
- [ ] capsule-cli
- [ ] capsule-core-rust
- [ ] capsule-desktop
- [ ] capsule-docs
- [ ] capsule-media
- [ ] capsule-swift
- [ ] capsule-web
- [ ] Other: _____________________

## Steps to Reproduce
Expand Down
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/chore.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ assignees: ''
<!-- Why is this necessary? -->

## Component
- [ ] pixles-android
- [ ] pixles-api
- [ ] pixles-cli
- [ ] pixles-core-rust
- [ ] pixles-desktop
- [ ] pixles-docs
- [ ] pixles-media
- [ ] pixles-swift
- [ ] pixles-web
- [ ] capsule-android
- [ ] capsule-api
- [ ] capsule-cli
- [ ] capsule-core-rust
- [ ] capsule-desktop
- [ ] capsule-docs
- [ ] capsule-media
- [ ] capsule-swift
- [ ] capsule-web
- [ ] Other: _____________________

## Proposed Changes
Expand Down
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ assignees: ''
<!-- A clear and concise description of the feature you'd like to see -->

## Component
- [ ] pixles-android
- [ ] pixles-api
- [ ] pixles-cli
- [ ] pixles-core-rust
- [ ] pixles-desktop
- [ ] pixles-docs
- [ ] pixles-media
- [ ] pixles-swift
- [ ] pixles-web
- [ ] capsule-android
- [ ] capsule-api
- [ ] capsule-cli
- [ ] capsule-core-rust
- [ ] capsule-desktop
- [ ] capsule-docs
- [ ] capsule-media
- [ ] capsule-swift
- [ ] capsule-web
- [ ] Other: _____________________

## Use Case
Expand Down
18 changes: 9 additions & 9 deletions .github/ISSUE_TEMPLATE/security_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ assignees: ''
<!-- A clear and concise description of the security issue -->

## Component
- [ ] pixles-android
- [ ] pixles-api
- [ ] pixles-cli
- [ ] pixles-core-rust
- [ ] pixles-desktop
- [ ] pixles-docs
- [ ] pixles-media
- [ ] pixles-swift
- [ ] pixles-web
- [ ] capsule-android
- [ ] capsule-api
- [ ] capsule-cli
- [ ] capsule-core-rust
- [ ] capsule-desktop
- [ ] capsule-docs
- [ ] capsule-media
- [ ] capsule-swift
- [ ] capsule-web
- [ ] Other: _____________________

## Steps to Reproduce (if safe to share)
Expand Down
8 changes: 7 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Pixles
# Capsule

## Code Style

- Self-validation: Most if not all code should be modular, reusable, and testable. The code that requires human review and manual testing should be minimal and focused on user facing features. All critical code must be primarily covered by complete and automated tests.
- Contract-driven development: Define the interfaces and data structures first, along with all test cases, before implementing the actual logic.
- Cohesion: All code should be split into cohesive modules that have a single responsibility and clear interfaces. Encapsulate unnecessary details.
- Minimalism: Choose to use a dependency if it reduces the scope of testing and quantity of code and as long as it does not compromise on performance and required capabilities.
- Traceability: all critical processes are verbosely logged so it is clear what happened after the fact and recovery can be feasible. Use INFO logs where necessary and DEBUG,TRACE aggressively for all critical processes. Logs should be structured and easily queryable. Instrument hot paths (e.g. major functions) for performance monitoring and debugging in production.
- Mocking: Use mocks for all external dependencies and critical internal processes. This allows us to have deterministic tests and easily simulate edge cases and failure scenarios that are hard to reproduce with real dependencies. Do not try to wire up two incomplete complex systems to mock each other.
- Linting and formatting is setup to be strict. Pre-commit and pre-push hooks are configured so you won't be able to push code that doesn't meet the standards.
Loading
Loading