kolbold 1.0.2

A Rust library for memory and time metrics collection.
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


# Contributing to Kolbold

First off, thank you for considering contributing to Kolbold! It's people like you that make open-source projects successful. We want to make contributing to this project as easy and transparent as possible.

## How Can I Contribute?

### Reporting Bugs
If you find a bug in the project, please open an issue in the GitHub repository and provide detailed steps to reproduce it. Include as much relevant information as possible, such as:
- Version of Kolbold you are using
- Any relevant stack traces or logs
- Steps or code snippets to reproduce the issue

### Suggesting Enhancements
Enhancements and feature requests are also welcome. If you have an idea that you believe could improve the project:
- Open an issue on the GitHub repository.
- Clearly outline the idea and the use case.
- Explain how it could benefit the project and its users.

### Submitting Pull Requests
1. Fork the repository and clone your fork locally.
2. Create a new branch for your changes:
   ```
   git checkout -b feature/your-feature-name
   ```
3. Make your changes and ensure the code follows the coding standards.
4. Test your changes to make sure nothing breaks.
5. Commit your changes with a clear and concise commit message:
   ```
   git commit -m "Add feature: your-feature-name"
   ```
6. Push to your fork:
   ```
   git push origin feature/your-feature-name
   ```
7. Create a Pull Request from your branch to the `main` branch of the main repository.
8. Wait for a project maintainer to review your PR. Make any requested changes as needed.

### Code Style and Standards
- Follow Rust's best practices and idiomatic code style.
- Use `cargo fmt` to format your code and `cargo clippy` to catch common issues.
- Write tests for any new functionality and ensure all existing tests pass with `cargo test`.

### Code of Conduct
This project follows the [Contributor Covenant Code of Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). By participating, you are expected to uphold this code.

## Getting Started
To get started, clone the project and install the necessary dependencies:
```
git clone https://github.com/yourusername/kolbold.git
cd kolbold
cargo build
```

Run tests with:
```
cargo test
```

## Thank You!
Your contributions are greatly appreciated. Thank you for helping make Kolbold better!