Skip to content

Docs: improve Contributing #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bxvtr merged 1 commit into from
Feb 18, 2026
Merged

Docs: improve Contributing #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 10 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ Thank you for your interest in contributing!
This repository focuses on deterministic, event-driven trading architecture.
Contributions should preserve clarity, explicitness and reproducibility.

---

## Design Principles

All contributions must respect the core design philosophy:
Expand All @@ -17,13 +19,17 @@ All contributions must respect the core design philosophy:

Avoid introducing implicit behavior or non-deterministic execution paths.

---

## Workflow

1. Fork the repository
2. Create a feature branch
3. Commit small, logical changes
4. Open a Pull Request with clear description

---

## Commit Style

Use clear messages:
Expand All @@ -32,6 +38,8 @@ feat: add monitoring overlay
fix: correct SecretProviderClass parameters
docs: update bootstrap instructions

---

## Development Environment

Recommended:
Expand All @@ -45,6 +53,8 @@ Alternatively:
pip install -e .
```

---

## Testing

Before submitting:
Expand Down