Merge branch 'main' into http-config

Author: Byron

Diff for: Cargo.lock

@@ -85,7 +85,7 @@ cache-efficiency-debug = ["git-features/cache-efficiency-debug"]
 anyhow = "1.0.42"
 
 gitoxide-core = { version = "^0.21.0", path = "gitoxide-core" }
-git-features = { version = "^0.24.0", path = "git-features" }
+git-features = { version = "^0.24.1", path = "git-features" }
 git-repository = { version = "^0.29.0", path = "git-repository", default-features = false }
 
 clap = { version = "3.2.5", features = ["derive", "cargo"] }
@@ -174,6 +174,7 @@ members = [
     "git-path",
     "git-repository",
     "gitoxide-core",
+    "git-hashtable",
     "git-tui",
     "git-tix",
 

Diff for: Cargo.toml

@@ -17,6 +17,65 @@
    * provide an error chain and make it easy to understand what went wrong. 
    * We `thiserror` generally.
  * Adhere to the [stability guide](https://github.com/Byron/gitoxide/blob/main/STABILITY.md)
+
+## Commit Messages
+
+We use a style I'd call 'purposeful [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)', and instead of classifying
+every commit using _conventional commit_ messaging, we do so only if the message should show up in the changelog.
+
+The _subject_ usually informs about the *what* and the body provides details and explains the *why*.
+
+Commit messages _must_ show up in the changelog in case of breaking changes. Examples for that are:
+
+- change!: rename `Foo` to `Bar`. (#123)
+  
+  And this is why we do it in the body.
+- remove!: `Repository::obsolete()`.
+ 
+  Nobody used this method.
+
+Features or other changes that are visible and people should know about look like this:
+
+- feat: add `Repository::foo()` to do great things. (#234)
+
+  And here is how it's used and some more details.
+- fix: don't panic when calling `foo()` in a bare repository. (#456)
+
+Everything else, particularly refactors or chores, don't use _conventional commits_ as these don't affect users of the API.
+Examples could be:
+
+- make test module structure similar to the modules they are testing for consistency
+- `make fmt`
+- thanks clippy
+
+Please refrain from using `chore:` or `refactor:` prefixes as for the most part, users of the API don't care about those. When a `refactor` 
+changes the API in some way, prefer to use `feat`, `change`, `rename` or `remove` instead, and most of the time the ones that are not `feat`
+are breaking so would be seen with their _exclamation mark_ suffix, like `change!`.
+
+### Reasoning
+
+Commit messages are used for guiding `cargo smart-release` to do most of the release work for us. This includes changelog generation
+as well as picking the right version bump for each crate.
+
+## Commit splitting on breaking changes.
+
+Knowing that `cargo smart-release` is driven by commit messages and affects their versions with per-crate granularity, it becomes important
+to split edits into multiple commits to clearly indicate which crate is actually broken.
+
+Typical patterns include making a breaking change in one crate and then fix all others to work with it. For changelogs to look proper
+and version bumps to be correct, the first commit would contain only the breaking changes themselves, 
+like "rename: `foo()` to `bar()`", and the second commit would contain all changes to adapt to that and look like "adapt to changes in `<crate name>`".
+
+## Commit History
+
+We generally follow a 'track everything' approach and there is a lot of freedom leading to more commits rather than less. There 
+is no obligation to squash commits or to otherwise tune the history.
+
+We use feature branches and PRs most of the time to be able to take advantage of CI and GitHub review tools, and merge with merge commits
+to make individual efforts stand out. There is no need for linearizing history or tuning it in any other way. However, each commit 
+_must_ follow the guidelines laid out in the `Commit Messages` paragraph.
+
+There is value in organizing commits by topic and [_Stacked Git_](https://stacked-git.github.io) is hereby endorsed to do that.
 
 ## Configuration and overrides
 

Diff for: DEVELOPMENT.md

@@ -156,6 +156,7 @@ is usable to some extend.
   * [git-worktree](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-worktree)
   * [git-bitmap](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-bitmap)
   * [git-date](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-date)
+  * [git-hashtable](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-hashtable)
 * **idea** _(just a name placeholder)_
   * [git-note](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-note)
   * [git-fetchhead](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-fetchhead)

Diff for: README.md

@@ -11,6 +11,12 @@
 * [x] decode the chunk file table of contents and provide convenient API
 * [x] write the table of contents
 
+### git-hashtable
+
+* [x] hashmap
+* [x] hashset
+
+
 ### git-object
 * *decode (zero-copy)* borrowed objects
     * [x] commit

Diff for: crate-status.md

@@ -32,7 +32,7 @@ echo "in root: gitoxide CLI"
 (enter git-config && indent cargo diet -n --package-size-limit 120KB)
 (enter git-config-value && indent cargo diet -n --package-size-limit 20KB)
 (enter git-command && indent cargo diet -n --package-size-limit 5KB)
-(enter git-hash && indent cargo diet -n --package-size-limit 20KB)
+(enter git-hash && indent cargo diet -n --package-size-limit 30KB)
 (enter git-chunk && indent cargo diet -n --package-size-limit 10KB)
 (enter git-rebase && indent cargo diet -n --package-size-limit 5KB)
 (enter git-sequencer && indent cargo diet -n --package-size-limit 5KB)
@@ -43,6 +43,7 @@ echo "in root: gitoxide CLI"
 (enter git-url && indent cargo diet -n --package-size-limit 20KB)
 (enter git-validate && indent cargo diet -n --package-size-limit 5KB)
 (enter git-date && indent cargo diet -n --package-size-limit 15KB)
+(enter git-hashtable && indent cargo diet -n --package-size-limit 5KB)
 (enter git-filter && indent cargo diet -n --package-size-limit 5KB)
 (enter git-lfs && indent cargo diet -n --package-size-limit 5KB)
 (enter git-note && indent cargo diet -n --package-size-limit 5KB)

Diff for: etc/check-package-size.sh

@@ -10,6 +10,6 @@ publish = false
 [dependencies]
 anyhow = "1"
 git-repository = { version = "^0.29.0", path = "../../git-repository" }
-git-features-for-config = { package = "git-features", version = "^0.24.0", path = "../../git-features", features = ["cache-efficiency-debug"] }
+git-features-for-config = { package = "git-features", version = "^0.24.1", path = "../../git-features", features = ["cache-efficiency-debug"] }
 git2 = "0.14"
 rayon = "1.5.0"

Diff for: experiments/diffing/Cargo.toml

@@ -5,6 +5,32 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## 0.14.1 (2022-11-27)
+
+### New Features
+
+ - <csr-id-fd287530e06ada04b811d9c8526eb698bc4c90fe/> `From` implementation from `&Signature` to `SignatureRef<'_>`.
+
+### Commit Statistics
+
+<csr-read-only-do-not-edit/>
+
+ - 2 commits contributed to the release over the course of 5 calendar days.
+ - 5 days passed between releases.
+ - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
+ - 0 issues like '(#ID)' were seen in commit messages
+
+### Commit Details
+
+<csr-read-only-do-not-edit/>
+
+<details><summary>view details</summary>
+
+ * **Uncategorized**
+    - `From` implementation from `&Signature` to `SignatureRef<'_>`. ([`fd28753`](https://github.com/Byron/gitoxide/commit/fd287530e06ada04b811d9c8526eb698bc4c90fe))
+    - Merge branch 'main' into http-config ([`bcd9654`](https://github.com/Byron/gitoxide/commit/bcd9654e56169799eb706646da6ee1f4ef2021a9))
+</details>
+
 ## 0.14.0 (2022-11-21)
 
 ### New Features (BREAKING)
@@ -24,7 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 <csr-read-only-do-not-edit/>
 
- - 3 commits contributed to the release over the course of 2 calendar days.
+ - 4 commits contributed to the release over the course of 2 calendar days.
  - 42 days passed between releases.
  - 1 commit was understood as [conventional](https://www.conventionalcommits.org).
  - 0 issues like '(#ID)' were seen in commit messages
@@ -36,6 +62,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 <details><summary>view details</summary>
 
  * **Uncategorized**
+    - Release git-hash v0.10.0, git-features v0.24.0, git-date v0.3.0, git-actor v0.14.0, git-glob v0.5.0, git-path v0.6.0, git-quote v0.4.0, git-attributes v0.6.0, git-config-value v0.9.0, git-tempfile v3.0.0, git-lock v3.0.0, git-validate v0.7.0, git-object v0.23.0, git-ref v0.20.0, git-sec v0.5.0, git-config v0.12.0, git-command v0.2.0, git-prompt v0.2.0, git-url v0.11.0, git-credentials v0.7.0, git-diff v0.23.0, git-discover v0.9.0, git-bitmap v0.2.0, git-traverse v0.19.0, git-index v0.9.0, git-mailmap v0.6.0, git-chunk v0.4.0, git-pack v0.27.0, git-odb v0.37.0, git-packetline v0.14.0, git-transport v0.23.0, git-protocol v0.24.0, git-revision v0.7.0, git-refspec v0.4.0, git-worktree v0.9.0, git-repository v0.29.0, git-commitgraph v0.11.0, gitoxide-core v0.21.0, gitoxide v0.19.0, safety bump 28 crates ([`b2c301e`](https://github.com/Byron/gitoxide/commit/b2c301ef131ffe1871314e19f387cf10a8d2ac16))
     - prepare changelogs prior to release ([`e4648f8`](https://github.com/Byron/gitoxide/commit/e4648f827c97e9d13636d1bbdc83dd63436e6e5c))
     - Merge branch 'version2021' ([`0e4462d`](https://github.com/Byron/gitoxide/commit/0e4462df7a5166fe85c23a779462cdca8ee013e8))
     - upgrade edition to 2021 in most crates. ([`3d8fa8f`](https://github.com/Byron/gitoxide/commit/3d8fa8fef9800b1576beab8a5bc39b821157a5ed))

Diff for: git-actor/CHANGELOG.md

@@ -1,6 +1,6 @@
 [package]
 name = "git-actor"
-version = "0.14.0"
+version = "0.14.1"
 description = "A way to identify git actors"
 authors = ["Sebastian Thiel <[email protected]>"]
 repository = "https://github.com/Byron/gitoxide"
@@ -16,7 +16,7 @@ doctest = false
 serde1 = ["serde", "bstr/serde", "git-date/serde1"]
 
 [dependencies]
-git-features = { version = "^0.24.0", path = "../git-features", optional = true }
+git-features = { version = "^0.24.1", path = "../git-features", optional = true }
 git-date = { version = "^0.3.0", path = "../git-date" }
 
 quick-error = "2.0.0"

Diff for: git-actor/Cargo.toml

@@ -16,7 +16,7 @@ doctest = false
 serde1 = ["serde", "bstr/serde", "git-glob/serde1", "compact_str/serde"]
 
 [dependencies]
-git-features = { version = "^0.24.0", path = "../git-features" }
+git-features = { version = "^0.24.1", path = "../git-features" }
 git-path = { version = "^0.6.0", path = "../git-path" }
 git-quote = { version = "^0.4.0", path = "../git-quote" }
 git-glob = { version = "^0.5.0", path = "../git-glob" }

Diff for: git-attributes/Cargo.toml

@@ -17,7 +17,7 @@ doctest = false
 serde1 = ["serde", "git-hash/serde1", "bstr/serde"]
 
 [dependencies]
-git-features = { version = "^0.24.0", path = "../git-features", features = ["rustsha1"] }
+git-features = { version = "^0.24.1", path = "../git-features", features = ["rustsha1"] }
 git-hash = { version = "^0.10.0", path = "../git-hash" }
 git-chunk = { version = "^0.4.0", path = "../git-chunk" }
 

Diff for: git-commitgraph/Cargo.toml

@@ -15,7 +15,7 @@ include = ["src/**/*", "LICENSE-*", "README.md", "CHANGELOG.md"]
 serde1 = ["serde", "bstr/serde", "git-sec/serde1", "git-ref/serde1", "git-glob/serde1", "git-config-value/serde1"]
 
 [dependencies]
-git-features = { version = "^0.24.0", path = "../git-features"}
+git-features = { version = "^0.24.1", path = "../git-features"}
 git-config-value = { version = "^0.9.0", path = "../git-config-value" }
 git-path = { version = "^0.6.0", path = "../git-path" }
 git-sec = { version = "^0.5.0", path = "../git-sec" }