Getting Started
Before You Begin
Make sure you have the prerequisites installed, then follow the contribution workflow below.
Install Rust
The Aum Simulator is written in Rust. Install the latest stable toolchain via rustup.
Install rustup →Install Git
All OpenTrits projects use Git for version control. Make sure you have Git 2.x or later installed.
Download Git →Create a GitHub Account
Fork repositories, submit pull requests, and participate in discussions — all through GitHub.
Sign up for GitHub →Contribution Workflow
Follow these steps to make your first contribution.
1. Fork the repository
Click the "Fork" button on the GitHub repository page to create your own copy.
2. Clone your fork
git clone https://github.com/YOUR_USERNAME/aum-simulator.git
cd aum-simulator 3. Create a branch
git checkout -b feature/my-contribution 4. Make your changes
Write your code, add tests, and make sure everything compiles.
cargo build
cargo test 5. Push and open a PR
git push origin feature/my-contribution Then open a Pull Request on GitHub. Describe what you changed and why.
Ways to Contribute
You don't have to write code to make a meaningful contribution.
Code
Implement features, fix bugs, write tests, improve performance. Rust and systems programming experience is especially valuable.
Documentation
Write guides, improve READMEs, create tutorials, document APIs. Good docs make the project accessible to newcomers.
Research
Explore ternary computing theory, investigate implementation strategies, write technical analyses and proposals.
Testing
Try the simulator, report bugs, suggest improvements, verify edge cases. Fresh eyes catch what developers miss.
Code of Conduct
OpenTrits is committed to providing a welcoming and inclusive experience for everyone. We expect all participants to:
- Be respectful and constructive in all interactions
- Welcome newcomers and help them get oriented
- Focus on what is best for the community and the project
- Accept constructive criticism gracefully