Thank you for your interest in contributing to Uuid!
For any questions, please make a post on users.rust-lang.org, post on uuid-rs mailing list or join our gitter channel.
Reminder: All contributors need to follow our Code of Conduct.
uuid crate is still in flux. All features desired may not be present. As such
you are welcome to request for new features.
If you have the chance, please search existing issues, as there is a chance that someone has already requested your feature.
File your feature request with a descriptive title, as this helps others find your request.
You can request your feature by following this link and filling it in. The template used is shown below:
**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
**Describe the solution you'd like**
A clear and concise description of what you want to happen.
**Is it blocking?**
Is this issue blocking any of your work? If it is blocking any open source project, you can share the link of the issue
**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.
**Additional context**
Add any other context or screenshots about the feature request here.
**Other**
Other information like relevant issues, external links, etcWhile no one likes bugs, they are an unfortunate reality in software. Remember we can't fix bugs we don't know about, so don't be shy about reporting.
If you have the chance, please search existing issues, as there is a chance that someone has already reported your error. This isn't strictly needed, as sometimes you might not what exactly you are looking for.
File your issue with a descriptive title, as this helps others find your issue.
Reporting a bug is as easy as following this link and filling it in. The template used is shown below:
**Describe the bug**
A clear and concise description of what the bug is.
**To Reproduce**
Steps to reproduce the behavior:
1. ...
2. ...
3. ...
**Expected behavior**
A clear and concise description of what you expected to happen.
**Screenshots**
If applicable, add screenshots to help explain your problem.
**Specifications (please complete the following information):**
- Target
- Version [e.g. 1.0]
- Features Enabled
**Additional context**
Add any other context about the problem here.
**Other**
Other information like relevant issues, external links, etcSometimes a backtrace may be needed. In that case, set RUST_BACKTRACE
environment variable to 1. For example:
$ RUST_BACKTRACE=1 cargo buildPull requests are the primary mechanism we use to change Uuid. GitHub itself has some great documentation on using the Pull Request feature. We use the "fork and pull" model described here, where contributors push changes to their personal fork and create pull requests to bring those changes into the source repository.
Please make pull requests against:
masterwhen making non-breaking changesbreakingif your changes alter the public API in a breaking manner
Note Our minimum rust version supported currently is 1.18.0. Make sure you
don't use any Rust features introduced after this version. Our CI does test has
test builds for enforcing this restriction.
If the pull request is in work in progress stage, prepend[WIP] in your PR
title. WIP bot will make sure that the PR doesn't accident get merged.
When you feel that the PR is ready, please ping @uuid-rs/uuid team, so they can review your changes.
Documentation is an important part of Uuid. Lackluster or incorrect documentation can cause headaches for the users of Uuid. Therefore, documentation improvements are always welcome.
We follow the documentation style guidelines as given by RFC 1574.
Sometimes, an issue might stay open even after the relevant bug has been fixed. Other times, the bug report may become invalid. Or we may just forget about the bug.
You can help to go through old bug reports and check if they are still valid. You can follow this link to look for issues like this.