atlas-local 0.6.0

A library for managing MongoDB Atlas local environments.
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

# Contributing to MongoDB Atlas Local Library

We welcome contributions to the MongoDB Atlas Local Library! This guide will help you get started with contributing to the project.

## Prerequisites

Before contributing, make sure you have:

- **Docker**: Docker must be installed and running on your system
- **Rust**: Rust 1.70 or later (edition 2024)

## Quick Start

1. **Fork the repository**
2. **Clone your fork**:
   ```bash
   git clone https://github.com/your-username/atlas-local-lib.git
   cd atlas-local-lib
   ```
3. **Create a feature branch**: `git checkout -b feature/amazing-feature`
4. **Set up your environment**:
   ```bash
   # Build the project
   cargo build
   
   # Verify Docker is running and run tests
   docker info
   cargo test
   ```

## Development Workflow

### Making Changes

1. Create a new branch for your feature or bug fix
2. Make your changes in small, logical commits
3. Add tests for any new functionality
4. Before committing, run the complete validation suite:

```bash
# Format your code
cargo fmt

# Run linting
cargo clippy

# Run all tests
cargo test

# Check that code compiles
cargo check
```

### Code Style

This project follows standard Rust conventions:

- Use `cargo fmt` to format code
- Use `cargo clippy` to catch common mistakes
- Write comprehensive tests for new functionality
- Document all public APIs

### Testing

Since this library manages Docker containers, ensure Docker is running before executing tests:

```bash
# Verify Docker is available
docker info

# Run the full test suite
cargo test
```

### Documentation

```bash
# Generate documentation
cargo doc

# Generate and open documentation in browser
cargo doc --open
```

## License and Security Scanning

We use additional tools to ensure license compliance and security:

### cargo-deny

We use [`cargo-deny`](https://github.com/EmbarkStudios/cargo-deny) to scan for allowed licenses and security advisories:

```sh
cargo deny check
```

This verifies that all dependencies use acceptable licenses and checks for known security vulnerabilities.

### cargo-about

We use [`cargo-about`](https://github.com/EmbarkStudios/cargo-about) to generate our third-party licenses notice:

```sh
cargo about generate --frozen about.hbs > LICENSE-3RD-PARTY.txt
```

This generates the file containing all third-party license information for our dependencies.

## Submitting Your Changes

1. **Commit your changes**: `git commit -m 'Add amazing feature'`
2. **Push to your branch**: `git push origin feature/amazing-feature`
3. **Submit a pull request** against the main branch
4. **Provide a clear description** of what your changes do
5. **Link to any relevant issues**

## Questions or Issues?

If you have questions about contributing, feel free to:

1. Check existing issues and discussions
2. Create a new issue for questions
3. Reach out to the maintainers

Thank you for contributing to MongoDB Atlas Local Library!