# Contributing
## Bugs
Think you found a bug? Create an issue on the [issue tracker]. Be sure to include enough information to reproduce the issue, trying to eliminate anything unnecessary.
If an issue already exists for your bug, feel free to add another example! Even if it's similar to an existing one, it might help in narrowing down the cause.
## Pull Requests
All pull requests are appreciated! Even if it's just fixing a typo in documentation, it's an improvement from what we had before. If you're planning on making a larger change to the codebase, it's recommended that you either ask on Matrix or file an issue before doing so - it will save you time if the PR won't be accepted!
### Tests
Any PR modifying code should be accompanied by a change to tests (and possibly additions). Documentation should also be updated if necessary.
### Commits
Commits will almost certainly be squashed when merged, so don't stress about having the perfect commit message. It is appreciated to keep commits to logical chunks, as this makes it easier to review.
## Continuous Integration
Time uses [GitHub Actions] for continuous integration. Types are checked and the full test suite is run on Windows, Mac, and Linux on both the minimum supported Rust version (currently 1.40.0) and the most recent stable. Formatting is verified, as are clippy lints.
## Formatting
Time uses rustfmt for formatting, and uses a number of nightly features. As such, you will need to run `cargo +nightly fmt` before committing. Formatting is important, so not doing this may cause CI to fail!
## Linting
Time uses both rustc and clippy for linting. Linting is _very_ strict; this is to ensure correctness! Any rustc lints that are for behavior being phased out are denied for future-proofing, while edition lints are denied for clarity. Most clippy lints are either deny or warn, while a few are explicitly allowed due to being overly pedantic or not relevant to the time crate.
If you are overriding a lint with `#[allow()]`, it is recommended to document why you are doing so if it's not immediately obvious.
## Unsafe code
Unsafe is forbidden. Period. If you submit a pull request that alters the `#![forbid(unsafe_code)]` declaration, it will be closed without review.
[issue tracker]: https://github.com/time-rs/time/issues/new
[GitHub Actions]: https://github.com/features/actions