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
|
# Contribution guidelines
First off, thank you for considering contributing to ordered_multimap.
If your contribution is not straightforward, please first discuss the change you wish to make by creating a new issue
before making the change.
## Reporting issues
Before reporting an issue on the [issue tracker](https://github.com/sgodwincs/ordered_multimap/issues), please
check that it has not already been reported by searching for some related keywords.
## Pull requests
Try to do one pull request per change.
### Updating the changelog
Update the changes you have made in
[CHANGELOG](https://github.com/sgodwincs/ordered_multimap/blob/main/CHANGELOG.md)
file under the **Unreleased** section.
Add the changes of your pull request to one of the following subsections, depending on the types of changes defined by
[Keep a changelog](https://keepachangelog.com/en/1.0.0/):
- `Added` for new features.
- `Changed` for changes in existing functionality.
- `Deprecated` for soon-to-be removed features.
- `Removed` for now removed features.
- `Fixed` for any bug fixes.
- `Security` in case of vulnerabilities.
If the required subsection does not exist yet under **Unreleased**, create it!
## Developing
### Set up
This is no different than other Rust projects.
```shell
git clone https://github.com/sgodwincs/ordered_multimap
cd ordered_multimap
cargo test
```
### Useful Commands
- Run Clippy:
```shell
cargo clippy --all-targets --all-features --workspace
```
- Run all tests:
```shell
cargo test --all-features --workspace
```
- Check to see if there are code formatting issues
```shell
cargo fmt --all -- --check
```
- Format the code in the project
```shell
cargo fmt --all
```
## Code of Conduct
This project adheres to the Rust Code of Conduct, which can be found [here](https://www.rust-lang.org/conduct.html).
|
