Skip to content

Better contributing documentation #50

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
unsecretised merged 1 commit into from
Dec 28, 2025
Merged

Better contributing documentation #50

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
25 changes: 25 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,3 +20,28 @@ For bug fixes, and helping people to solve their github issues: see
1. Code must compile...
1. A video recording / screenshot would be an added bonus in getting your pull
request merged faster.

## Codebase:

```
.
├── bundling # Bundling related stuff, ignore for the most bit
│   ├── entitlements.plist
│   ├── icon.icns
│   └── Info.plist
├── docs # Website and documentation related stuff. If something new is added to config, then modify this as well before PR-ing
├── Cargo.lock
├── Cargo.toml
├── CONTRIBUTING.md
├── EXTENSIONS.md
├── LICENSE.md
├── README.md
└── src
├── app.rs # Main app logic
├── calculator.rs # Calculator logic
├── commands.rs # Logic for different commands
├── config.rs # Configuration related stuff
├── macos.rs # Macos specific config
├── main.rs # Start app
└── utils.rs # Common functions that are used across files
```