Documentation and Licensing #28

epage · 2018-04-17T01:13:01Z

Fixes #22 and #23

nastevens · 2018-04-17T02:19:56Z

"Contribution" is misspelled in the commit message for 60ce654

nastevens · 2018-04-17T02:55:25Z

CONTRIBUTING.md

+
+## Feature Requests
+
+Need some new functionality to help?  You can let us know by opening an [issue][new issue]. It's helpful to look through [all


nit: wrap to 80 columns

nastevens · 2018-04-17T02:55:49Z

CONTRIBUTING.md

+## Bug Reports
+
+Please let us know about what problems you run into, whether in behavior or
+ergonomics of API.  You can do this by opening an [issue][new issue].. It's


nit: extra period

nastevens · 2018-04-17T02:57:39Z

CONTRIBUTING.md

+
+### Process
+
+When you first post a PR, it might be good to clean up the commit history.  We


Rephrase from "it might be a good idea" to "we request that"? There really aren't any times I wouldn't want a messy commit history cleaned up.

nastevens · 2018-04-17T02:58:35Z

CONTRIBUTING.md

+history.  Once you let us know this is done, we can move forward with merging!
+If you are uncomfortable with these parts of git, let us know and we can help.
+
+We ask that all new files have the copyright header.  Please update the


Maybe include the text of the copyright header here? Or in an appendix?

I was going to but skipped it to see how much you cared out of concern for keeping the year up to date in it (or having a placeholder <YEAR> in it). I was figuring its easy enough to grab from another file.

So if you want it there more than willing to add it.

nastevens · 2018-04-17T03:14:48Z

CONTRIBUTING.md

+When we're ready to release, a project owner should do the following
+- Determine what the next version is, according to semver
+- Bump version in a commit
+  - Run `clog --setversion <X>.<Y>.<Z>`, touch up the log


I fall on the side of "changelogs are for humans, they should be written by humans". Specifically, when I'm looking at a changelog I don't care to see each commit described, I want to see what has "changed" for the human using the library. Tools like clog can be helpful for checking that everything was covered but I shy away from recommending them as the primary way to generate changelogs. https://keepachangelog.com/en/1.0.0/ lays out the reasons for this better than I ever could.

I think I'd feel better about recommending clog if there was also a mention of keepachangelog.com and something more like "curating the changes" than "touching up the log".

Yeah, killercup and I have had discussions on this (which his posts are what led me to clog).

I've been using clog with cobalt and liquid and its been good enough for the time with minimal changes to the generated output.

My leaning is to just remove this line atm and not talk about changelogs and you can come in with a PR with a more detailed explanation of how you want to handle changelogs. I propose this because if you aren't using clog, it seems like we'd want to document steps in the PR section and here and that way you can choose how you'd like.

nastevens · 2018-04-17T03:16:14Z

CONTRIBUTING.md

+  - Update the version in `Cargo.toml`
+  - Update the dependency version in `src/lib.rs`
+  - Update the dependency version in `README.md`
+- Tag the commit via `git tag -a v<X>.<Y>.<Z>`


Annotated tags require a message, which I almost always just set to the same text as the version. This command could just be git tag -am "v<X>.<Y>.<Z>" v<X>.<Y>.<Z> and eliminate some ambiguity.

I'll do this for now but I still want to explore sometime what are the best tag messages.

The fact that github automatically shows the messages and that its then easy to pull that out into release notes, I tend to put the changelog notes in my message.

Fixes assert-rs#23

Fixes assert-rs#22

The Issue template is based on rust's `CONTRIBUTING.md`. The PR template is a quick reminder of things from our `CONTRIBUTING.md`.

epage · 2018-04-17T04:08:58Z

Meant to add the templates when writing CONTRIBUTING.md.

This PR contains the following updates: | Package | Update | Change | |---|---|---| | [STABLE](https://redirect.github.com/rust-lang/rust) | minor | `1.87` -> `1.88` | --- ### Release Notes <details> <summary>rust-lang/rust (STABLE)</summary> ### [`v1.88`](https://redirect.github.com/rust-lang/rust/blob/HEAD/RELEASES.md#Version-1880-2025-06-26) [Compare Source](https://redirect.github.com/rust-lang/rust/compare/1.87.0...1.88.0) \========================== <a id="1.88.0-Language"></a> ## Language - [Stabilize `#![feature(let_chains)]` in the 2024 edition.](https://redirect.github.com/rust-lang/rust/pull/132833) This feature allows `&&`-chaining `let` statements inside `if` and `while`, allowing intermixture with boolean expressions. The patterns inside the `let` sub-expressions can be irrefutable or refutable. - [Stabilize `#![feature(naked_functions)]`.](https://redirect.github.com/rust-lang/rust/pull/134213) Naked functions allow writing functions with no compiler-generated epilogue and prologue, allowing full control over the generated assembly for a particular function. - [Stabilize `#![feature(cfg_boolean_literals)]`.](https://redirect.github.com/rust-lang/rust/pull/138632) This allows using boolean literals as `cfg` predicates, e.g. `#[cfg(true)]` and `#[cfg(false)]`. - [Fully de-stabilize the `#[bench]` attribute](https://redirect.github.com/rust-lang/rust/pull/134273). Usage of `#[bench]` without `#![feature(custom_test_frameworks)]` already triggered a deny-by-default future-incompatibility lint since Rust 1.77, but will now become a hard error. - [Add warn-by-default `dangerous_implicit_autorefs` lint against implicit autoref of raw pointer dereference.](https://redirect.github.com/rust-lang/rust/pull/123239) The lint [will be bumped to deny-by-default](https://redirect.github.com/rust-lang/rust/pull/141661) in the next version of Rust. - [Add `invalid_null_arguments` lint to prevent invalid usage of null pointers.](https://redirect.github.com/rust-lang/rust/pull/119220) This lint is uplifted from `clippy::invalid_null_ptr_usage`. - [Change trait impl candidate preference for builtin impls and trivial where-clauses.](https://redirect.github.com/rust-lang/rust/pull/138176) - [Check types of generic const parameter defaults](https://redirect.github.com/rust-lang/rust/pull/139646) <a id="1.88.0-Compiler"></a> ## Compiler - [Stabilize `-Cdwarf-version` for selecting the version of DWARF debug information to generate.](https://redirect.github.com/rust-lang/rust/pull/136926) <a id="1.88.0-Platform-Support"></a> ## Platform Support - [Demote `i686-pc-windows-gnu` to Tier 2.](https://blog.rust-lang.org/2025/05/26/demoting-i686-pc-windows-gnu/) Refer to Rust's [platform support page][platform-support-doc] for more information on Rust's tiered platform support. [platform-support-doc]: https://doc.rust-lang.org/rustc/platform-support.html <a id="1.88.0-Libraries"></a> ## Libraries - [Remove backticks from `#[should_panic]` test failure message.](https://redirect.github.com/rust-lang/rust/pull/136160) - [Guarantee that `[T; N]::from_fn` is generated in order of increasing indices.](https://redirect.github.com/rust-lang/rust/pull/139099), for those passing it a stateful closure. - [The libtest flag `--nocapture` is deprecated in favor of the more consistent `--no-capture` flag.](https://redirect.github.com/rust-lang/rust/pull/139224) - [Guarantee that `{float}::NAN` is a quiet NaN.](https://redirect.github.com/rust-lang/rust/pull/139483) <a id="1.88.0-Stabilized-APIs"></a> ## Stabilized APIs - [`Cell::update`](https://doc.rust-lang.org/stable/std/cell/struct.Cell.html#method.update) - [`impl Default for *const T`](https://doc.rust-lang.org/nightly/std/primitive.pointer.html#impl-Default-for-*const+T) - [`impl Default for *mut T`](https://doc.rust-lang.org/nightly/std/primitive.pointer.html#impl-Default-for-*mut+T) - [`HashMap::extract_if`](https://doc.rust-lang.org/stable/std/collections/struct.HashMap.html#method.extract_if) - [`HashSet::extract_if`](https://doc.rust-lang.org/stable/std/collections/struct.HashSet.html#method.extract_if) - [`proc_macro::Span::line`](https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.line) - [`proc_macro::Span::column`](https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.column) - [`proc_macro::Span::start`](https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.start) - [`proc_macro::Span::end`](https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.end) - [`proc_macro::Span::file`](https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.file) - [`proc_macro::Span::local_file`](https://doc.rust-lang.org/stable/proc_macro/struct.Span.html#method.local_file) These previously stable APIs are now stable in const contexts: - [`NonNull<T>::replace`](https://doc.rust-lang.org/stable/std/ptr/struct.NonNull.html#method.replace) - [`<*mut T>::replace`](https://doc.rust-lang.org/stable/std/primitive.pointer.html#method.replace) - [`std::ptr::swap_nonoverlapping`](https://redirect.github.com/rust-lang/rust/pull/137280) - [`Cell::{replace, get, get_mut, from_mut, as_slice_of_cells}`](https://redirect.github.com/rust-lang/rust/pull/137928) <a id="1.88.0-Cargo"></a> ## Cargo - [Stabilize automatic garbage collection.](https://redirect.github.com/rust-lang/cargo/pull/14287/) - [use `zlib-rs` for gzip compression in rust code](https://redirect.github.com/rust-lang/cargo/pull/15417/) <a id="1.88.0-Rustdoc"></a> ## Rustdoc - [Doctests can be ignored based on target names using `ignore-*` attributes.](https://redirect.github.com/rust-lang/rust/pull/137096) - [Stabilize the `--test-runtool` and `--test-runtool-arg` CLI options to specify a program (like qemu) and its arguments to run a doctest.](https://redirect.github.com/rust-lang/rust/pull/137096) <a id="1.88.0-Compatibility-Notes"></a> ## Compatibility Notes - [Finish changing the internal representation of pasted tokens](https://redirect.github.com/rust-lang/rust/pull/124141). Certain invalid declarative macros that were previously accepted in obscure circumstances are now correctly rejected by the compiler. Use of a `tt` fragment specifier can often fix these macros. - [Fully de-stabilize the `#[bench]` attribute](https://redirect.github.com/rust-lang/rust/pull/134273). Usage of `#[bench]` without `#![feature(custom_test_frameworks)]` already triggered a deny-by-default future-incompatibility lint since Rust 1.77, but will now become a hard error. - [Fix borrow checking some always-true patterns.](https://redirect.github.com/rust-lang/rust/pull/139042) The borrow checker was overly permissive in some cases, allowing programs that shouldn't have compiled. - [Update the minimum external LLVM to 19.](https://redirect.github.com/rust-lang/rust/pull/139275) - [Make it a hard error to use a vector type with a non-Rust ABI without enabling the required target feature.](https://redirect.github.com/rust-lang/rust/pull/139309) </details> --- ### Configuration 📅 **Schedule**: Branch creation - Every minute ( * * * * * ) (UTC), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Enabled. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR was generated by [Mend Renovate](https://mend.io/renovate/). View the [repository job log](https://developer.mend.io/github/epage/_rust).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

epage requested a review from nastevens April 17, 2018 01:13

nastevens reviewed Apr 17, 2018

View reviewed changes

fix: Update licensing

a86635e

Fixes assert-rs#23

epage force-pushed the misc branch from df53a41 to edb2e88 Compare April 17, 2018 03:38

epage added 3 commits April 16, 2018 21:51

docs: Contribution information

98857cd

Fixes assert-rs#22

docs: Align README example with new layout

10cb02d

docs: Add github templates

112b493

The Issue template is based on rust's `CONTRIBUTING.md`. The PR template is a quick reminder of things from our `CONTRIBUTING.md`.

epage force-pushed the misc branch from edb2e88 to 112b493 Compare April 17, 2018 04:08

epage merged commit 096a3e7 into assert-rs:master May 9, 2018

epage deleted the misc branch May 9, 2018 16:02

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Documentation and Licensing #28

Documentation and Licensing #28

Uh oh!

epage commented Apr 17, 2018

Uh oh!

nastevens commented Apr 17, 2018

Uh oh!

nastevens Apr 17, 2018

Uh oh!

nastevens Apr 17, 2018

Uh oh!

nastevens Apr 17, 2018

Uh oh!

nastevens Apr 17, 2018

Uh oh!

epage Apr 17, 2018

Uh oh!

nastevens Apr 17, 2018

Uh oh!

epage Apr 17, 2018

Uh oh!

nastevens Apr 17, 2018

Uh oh!

epage Apr 17, 2018

Uh oh!

epage commented Apr 17, 2018

Uh oh!

Uh oh!


		## Feature Requests

		Need some new functionality to help? You can let us know by opening an [issue][new issue]. It's helpful to look through [all


		### Process

		When you first post a PR, it might be good to clean up the commit history. We

Documentation and Licensing #28

Documentation and Licensing #28

Uh oh!

Conversation

epage commented Apr 17, 2018

Uh oh!

nastevens commented Apr 17, 2018

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

epage commented Apr 17, 2018

Uh oh!

Uh oh!