Skip to content

Commit 053d38b

Browse files
Its-Just-Nansgemini-code-assist[bot]Pr0methean
authored
chore: cleanup repository files (#743)
* chore: cleanup repository files * remove line * Update README.md Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Signed-off-by: n4n5 <git@n4n5.dev> --------- Signed-off-by: n4n5 <git@n4n5.dev> Co-authored-by: gemini-code-assist[bot] <176961590+gemini-code-assist[bot]@users.noreply.github.com> Co-authored-by: Chris Hennick <4961925+Pr0methean@users.noreply.github.com>
1 parent 52d8412 commit 053d38b

4 files changed

Lines changed: 8 additions & 10 deletions

File tree

pull_request_template.md renamed to .github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<!--
1+
<!--
22
We welcome your pull request, but because this crate is downloaded about 1.7 million times per month (see https://crates.io/crates/zip),
33
and because ZIP file processing has caused security issues in the past (see
44
https://www.cvedetails.com/vulnerability-search.php?f=1&vendor=&product=zip&cweid=&cvssscoremin=&cvssscoremax=&publishdatestart=&publishdateend=&updatedatestart=&updatedateend=&cisaaddstart=&cisaaddend=&cisaduestart=&cisadueend=&page=1
@@ -18,8 +18,6 @@ These are our requirements for PRs, in addition to the usual functionality and r
1818
- 5 or more pull requests are already open at https://github.com/zip-rs/zip2/pulls. PRs are merged in the order they become
1919
eligible (reviewed, passing CI tests, and no conflicts with the base branch). I will attempt to fix merge
2020
conflicts, but this is best-effort.
21-
- Please make sure your PR's target repo is `zip-rs/zip2` and not `zip-rs/zip-old`. The latter
22-
repo is no longer maintained, and I will archive it after closing the pre-existing issues.
2321
- Your changes must build against the MSRV (see README.md) AND the latest stable Rust version AND the latest nightly Rust version.
2422
- PRs must pass all the checks specified in `.github/workflows/ci.yaml`, which include:
2523
- Unit tests, run with `--no-default-features` AND with `--all-features` AND with the default features, each run
@@ -33,6 +31,7 @@ These are our requirements for PRs, in addition to the usual functionality and r
3331
- The PR title must conform to [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) and start
3432
with one of the types specified by the [Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#type).
3533
This is also recommended for commit messages; but it's not required, because they'll be replaced when the PR is squash-merged.
34+
- It's always better if you add a test in your merge request
3635
3736
Thanks in advance for submitting a bug fix or proposed feature that meets these requirements!
3837
-->

Cargo.toml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,13 @@ authors = [
88
"Chris Hennick <hennickc@amazon.com>",
99
]
1010
license = "MIT"
11-
repository = "https://github.com/zip-rs/zip2.git"
11+
repository = "https://github.com/zip-rs/zip2"
1212
keywords = ["zip", "archive", "compression"]
1313
# Any change to rust-version must be reflected also in `README.md` and `.github/workflows/ci.yaml`.
1414
# The MSRV policy is documented in `README.md`.
1515
rust-version = "1.88"
1616
categories = ["compression", "filesystem", "parser-implementations"]
17-
description = """
18-
Library to support the reading and writing of zip files.
19-
"""
17+
description = "Library to support the reading and writing of zip files."
2018
edition = "2024"
2119
exclude = ["tests/**", "examples/**", ".github/**", "fuzz/**", ".amazonq/**", "benches/**", ".typos.toml"]
2220

LICENSE

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,3 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
1919
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
SOFTWARE.
22-
23-
Some files in the "tests/data" subdirectory of this repository are under other
24-
licences; see files named LICENSE.*.txt for details.

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,10 @@ we will follow these guidelines:
9696
- We will always support a minor Rust version that has been stable for at least 6 months.
9797
- Any change to the MSRV will be accompanied with a **minor** version bump.
9898

99+
## License
100+
101+
Licensed under the [MIT License](./LICENSE). Some files in the "tests/data" subdirectory of this repository are under other
102+
licenses; see files named `LICENSE.*.txt` for details.
99103

100104
## Fuzzing
101105

0 commit comments

Comments
 (0)