Commit Graph

29 Commits

Author SHA1 Message Date
Tobin C. Harding 472da02c58
policy: Add section on returning Self
Returning `Self` instead of the actual type makes refactoring easier,
especially for error enums.
2023-12-15 10:44:34 +11:00
Andrew Poelstra 50fc63b171
Merge rust-bitcoin/rust-bitcoin#1127: Add policy section to docs
3bebecc7ea Add policy section to docs (Tobin C. Harding)

Pull request description:

  In an effort to consolidate knowledge spread out over time in various places on GitHub add a `Policy` section to `CONTRIBUTING.md`.

  Add initial sections on import statements, errors, rustdocs,attributes, and licensing.

ACKs for top commit:
  apoelstra:
    ACK 3bebecc7ea
  Kixunil:
    ACK 3bebecc7ea

Tree-SHA512: fb1afd220a0afae962cd9c7a01df7d440eaa1406b446765af209e3b7840b36aa8a1254d57f9ff0c3783479111470828da3c76b5858ce5969519c96cdba71c7f3
2023-11-16 13:40:10 +00:00
Vojtěch Toman e3f2c4fa43
Fix broken link in CONTRIBUTING.md 2023-11-15 21:03:56 +01:00
Tobin C. Harding 3bebecc7ea
Add policy section to docs
In an effort to consolidate knowledge spread out over time in various
places on GitHub add a `Policy` section to `CONTRIBUTING.md`.

Add initial sections on import statements, errors, rustdocs,attributes,
and licensing.
2023-10-31 08:03:28 +11:00
Einherjar d391ada5b8
ci: nightly rustfmt PR scheduled/manual 2023-10-22 05:34:16 -03:00
Andrew Poelstra fc52fd9ced
Merge rust-bitcoin/rust-bitcoin#2045: Use correct terminology: carve out
b229fd5555 Use correct form for noun: carve-out (Tobin C. Harding)

Pull request description:

  One "carves out" something, not "carve output" - woops.

ACKs for top commit:
  apoelstra:
    ACK b229fd5555

Tree-SHA512: 196c5c239da35a67b83eb96f2f9346af6518af51ff6bb4a9e40cddab8c8511f2e913278a9727bfe4e97d50c58cb87a4100e40c13c8313643b04a2d0fabaaa9e5
2023-09-21 16:55:44 +00:00
Tobin C. Harding 4222e4d817
Add one-ack carve outside
In an effort to reduce review burden add so strict rules defining 3
times where we think it is acceptable for code to be merged with a
single ACK. Feels a bit like we only just added the refactor carve out
and now we are adding more carve outs, so whats next? We should take
these rules seriously, if we are to be taken seriously.
2023-09-04 08:17:22 +10:00
Tobin C. Harding b229fd5555
Use correct form for noun: carve-out
One is said to "carve out" something, not "carve output" - woops.
However, when used as a noun its written "carve-out".
2023-09-04 08:10:24 +10:00
Tobin C. Harding 55be538dac
policy: Add refactor carve out
I have managed to burn out or bore our reviewers/maintainers. Getting
two acks is becoming increasingly difficult. I've pestered everyone to
the limit that I feel socially comfortable doing so am requesting a
carve out to the 2-ACK before merge rule.

The primary justification is that I feel we should have a bit more of
BDFL and a bit less total consensus if we are to push forwards.
2023-07-18 09:58:55 +10:00
Martin Habovstiak c4c64c0dc5
Test with minimal dependency versions
It could happen that we unknowingly depend on a new version of a crate
without updating `Cargo.toml`. This could cause resolution issues for
downstream users. It's also unclear for outsiders to see which
dependencies we tested the crate with.

This change commits two lock files: `minimal` and `recent`. `minimal`
contains minimal depdendency versions, while `recent` contains
dependency versions at the time of making the change.

Further, this adds CI jobs to test with both lock files, CI job for
`internals` crate, removes old `serde` pinning and prints a warning if
`recent` is no longer up to date. (We may have to override it somehow if
any crate breaks MSRV.)

The documentation is also updated accordingly.

Co-developed-by: Tobin C. Harding <me@tobin.cc>

Closes #1230
2023-05-03 08:06:46 +10:00
Tobin C. Harding fe83ee6061
Update testing section
The testing section in `CONTRIBUTING.md` is stale, update it to point
readers towards the readme.
2023-03-21 15:29:32 +11:00
Tobin C. Harding 55312f2972
Update contributing docs re cargo fmt
Now that we use `cargo fmt`, update the section in the contributing
documentation.
2023-03-07 08:58:13 +11:00
Andrew Poelstra 779668879d
Merge rust-bitcoin/rust-bitcoin#1125: Update docs on rustfmt
b7eea6cb26 Update docs on rustfmt (Tobin C. Harding)

Pull request description:

  We have introduced `rustfmt` but forgot to update the docs section about
  it. Since a large portion of the codebase is currently ignored by our
  `rustfmt` configuration, point out that `rusntfmt` is work in progress.

ACKs for top commit:
  apoelstra:
    ACK b7eea6cb26
  Kixunil:
    ACK b7eea6cb26

Tree-SHA512: c3a01e38e9787f7554847c657de8d2aeb512f237f68e97973ffa04e92decd282126abf16edb369c13dbeb9eed3587e20dbfb3ab77e06551a006a7aa2c70a71ad
2022-09-14 13:34:49 +00:00
Tobin C. Harding b7eea6cb26 Update docs on rustfmt
We have introduced `rustfmt` but forgot to update the docs section about
it. Since a large portion of the codebase is currently ignored by our
`rustfmt` configuration, point out that `rusntfmt` is work in progress.
2022-07-26 17:20:00 +10:00
Tobin C. Harding fe840f0b42 Fix stale toolchain docs
We have docs that use an env var `BITCOIN_MSRV` that no longer exists.
Point readers towards `RUSTUP_TOOLCHAIN`.

(Note that we still use `TOOLCHAIN` in the script but it is being phased
out, `RUSTUP_TOOLCHAIN` works today.)
2022-07-26 11:09:47 +10:00
Tobin C. Harding 73b506e149 Remove stale MSRV docs
We have stale docs referring to the old MSRV. We do not need MSRV docs
in `CONTRIBUTING` because we have them in the README already.

Fix stale docs by doing:
- Remove the MSRV docs from readme in favour of `CONTRIBUTING.md`.
- Add a sentence to the redame pointing readers towards `CONTRIBUTING.md`.
2022-07-26 11:04:45 +10:00
Martin Habovštiak 7743be00cf
Removed edition change heads up from CONTRIBUTING
It is done.
2022-06-09 15:26:49 +02:00
Tobin C. Harding b5a76e0434 Remove dr-orlovsky from maintainer list
Dr Orlovsky is no longer maintaining rust-bitcoin projects. Remove his
name from the maintainer list.
2022-05-11 07:17:47 +10:00
Martin Habovstiak bd36d846f2 Add temporary warning about edition change
This warns contributors about possible rebases. Changing CONTRIBUTING
should ensure that GitHub will display special warning. This will be
removed after migration is done.
2022-04-20 20:15:49 +02:00
Tobin Harding 3786680cc7 Use correct script name
The test script is incorrectly named in our contributor docs. Fix it up
with the correct name.
2022-03-08 15:23:51 +11:00
Tobin Harding 42e10ff132 Only use two newlines before level 2 headings
In an attempt help maintain visual structure only use two newlines
before level 2 headings.
2022-01-19 11:14:21 +11:00
Tobin Harding 9be2fb6088 Remove Sebastian from maintainers list
Sebastian requested by email to be step down from the position of
maintainer of `rust-bitcoin`.
2022-01-19 11:12:09 +11:00
Tobin Harding 9407d103c5 Be uniform in heading spacing
We currently sometimes have one newline before headings and sometimes
two, its not important which it is but uniformity is nice.

Use two newlines before headings uniformly in `CONTRIBUTING.md`.
2022-01-18 09:59:22 +11:00
Tobin Harding af9389d724 Add Kixunil, RCassata, and tcharding to maintainers
We recently added `CONTRIBUTING.md` but forgot to add Martin, Ricardo.
Also a couple days ago Tobin was added to the repo.
2022-01-18 09:58:47 +11:00
Dr Maxim Orlovsky 31c49832b7 Fix IRC log record on gnusha.org 2022-01-13 17:59:20 +01:00
Dr Maxim Orlovsky e1c8e13cb8 Contributing: improving language and style 2022-01-10 22:14:17 +01:00
Dr Maxim Orlovsky 45dbaa7e26 Contributing: remove derivation section 2022-01-10 17:53:52 +01:00
Dr Maxim Orlovsky 313ac7d4a8 Contributing: improve formatting section 2022-01-10 17:53:52 +01:00
Dr Maxim Orlovsky 78d1a82769 Contributing guidelines 2022-01-10 17:53:26 +01:00