sticks 0.3.1

A tool for managing C and C++ projects
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

## Contribute and Stay Updated!


🌟 If you find Sticks useful, consider giving it a star! It helps us a lot!

📢 We welcome contributions and feedback from the community. Here's how you can get involved:

### How to Contribute:


1. 🐛 **Found a bug?** Open an [issue](https://github.com/mAmineChniti/sticks/issues) to report it.
2. 🚀 **Want to add a feature?** Fork the repository, create a new branch, add your feature, and submit a [pull request](https://github.com/mAmineChniti/sticks/pulls).
3. 📝 **Spotted a typo or have improvements to the documentation?** Submit a pull request with your changes.

### Development Workflow:


#### Setting Up Development Environment


```bash
# Clone with submodules (for AUR packaging)

git clone --recurse-submodules https://github.com/mAmineChniti/sticks.git
cd sticks

# Build in debug mode

cargo build

# Run tests

cargo test

# Run specific test file

cargo test --test dependencies_tests

# Build release binary

cargo build --release
```

#### Writing Code


- Follow Rust naming conventions and idioms
- Keep functions focused and modular
- Use `anyhow::Result` for error handling with context
- Avoid comments in code - keep code self-documenting

#### Testing Guidelines


**All new features must include tests!** We maintain 100% test coverage for core functionality.

```bash
# Run all tests

cargo test

# Run tests with output

cargo test -- --nocapture

# Run tests verbosely

cargo test --verbose
```

**Test Requirements:**
- Place tests in the `tests/` directory (not inline with source code)
- Use `#[serial]` attribute for tests that modify global state (like changing directories)
- Tests must clean up after themselves (delete temp directories, restore original state)
- Use unique temp directory names with process ID and timestamp
- Test both success and error cases

**Test Structure Example:**

```rust
use serial_test::serial;
use std::env;
use std::fs;

#[test]

#[serial]

fn test_my_feature() {
    // Setup: Create temp directory with unique name
    let temp_dir = env::temp_dir().join(format!(
        "sticks_test_{}_{}",
        std::process::id(),
        std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .unwrap()
            .as_nanos()
    ));
    let original_dir = env::current_dir().unwrap();
    
    fs::create_dir_all(&temp_dir).unwrap();
    env::set_current_dir(&temp_dir).unwrap();
    
    // Test logic here
    // ...
    
    // Cleanup: Restore directory and remove temp files
    env::set_current_dir(&original_dir).unwrap();
    fs::remove_dir_all(&temp_dir).ok();
}
```

#### Continuous Integration


Our CI/CD pipeline automatically:
- ✅ Runs all tests on every push and pull request
- ✅ Tests must pass before any code can be merged
- ✅ Builds and releases packages on version changes
- ✅ Publishes to crates.io and creates GitHub releases
- ✅ Builds for multiple architectures (x86_64, aarch64)

**Before submitting a PR:**
1. Ensure all tests pass: `cargo test`
2. Check formatting: `cargo fmt`
3. Run linter: `cargo clippy`
4. Build successfully: `cargo build --release`

### Ways to Help Out:


- 👩‍💻 **Code Contributions:** Help us improve Sticks by contributing code changes.
- 🐞 **Bug Reports:** Report any issues you encounter and help us squash bugs.
- 📖 **Documentation:** Enhance the project's documentation to make it more accessible.
- 🧪 **Testing:** Add more tests to improve coverage and reliability.
- 🎨 **UX Improvements:** Suggest or implement better user experience.

### Code Review Process:


1. Submit your PR with a clear description
2. Automated tests run via GitHub Actions
3. Maintainer reviews code and provides feedback
4. Address any requested changes
5. Once approved and tests pass, PR is merged

### Release Process:


Releases are automated:
1. Update version in `Cargo.toml`
2. Push to master branch
3. CI automatically creates git tag, GitHub release, and publishes packages
4. AUR package is updated automatically

### Stay Updated:


- 🌐 **Watch this repository:** Click on the "Watch" button to receive notifications about new releases and updates.
- 📦 **Check Releases:** Visit [releases page](https://github.com/mAmineChniti/sticks/releases) for changelogs
- 💬 **Join Discussions:** Participate in issues and pull request discussions

Thank you for your support! Your contributions make Sticks even better! 🚀