mirrors/arti.git/CONTRIBUTING.md, branch tor-circmgr-v0.18.1mirror of https://gitlab.torproject.org/tpo/core/arti
http://git.dilluti0n.com/mirrors/arti.git/atom?h=tor-circmgr-v0.18.12023-03-31T16:52:31ZMerge branch 'docs-runes' into 'main'2023-03-31T16:52:31ZIan Jacksoniwj@torproject.org2023-03-31T16:52:31Zurn:sha1:c8973ae2487e5343619ae5ec1fd14cbcf9df2193
CONTRIBUTING.md: Improve wording about docs builds recommendations
See merge request tpo/core/arti!1090CONTRIBUTING.md: Explicitly support --document-private-items2023-03-30T15:34:57ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-29T10:43:22Zurn:sha1:ab7e628555337497eaeb3ed9c1b3b287a84ffb54
We have many internal doc comments with curated links etc., so we
should actually mention that formatting and reading those can be
useful.
CONTRIBUTING.md: Recommend --workspace when building docs2023-03-30T15:34:53ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-29T10:42:01Zurn:sha1:922df2a10f5296870a37843cd9276144f5858569CONTRIBUTING.md: Add some refs for git autosquash2023-03-30T15:32:04ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-24T18:57:09Zurn:sha1:3746ad8c84c48d56fe3d9d280c4ce1d5440b6fef
One ref to the official docs, one to a reasonable-looking blog post I
found via DDG.
Suggested in
https://gitlab.torproject.org/tpo/core/arti/-/merge_requests/1079#note_2889631
CONTRIBUTING.md: Discourage contributors from rebasing (typo fix)2023-03-30T15:32:00ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-24T18:53:23Zurn:sha1:f7f3ad37ff0d148c5cac7dcf08f642178b1e670bCONTRIBUTING.md: Improve wording re not squashing2023-03-30T15:31:36ZNick Mathewsonnickm@torproject.org2023-03-24T18:52:42Zurn:sha1:b62c46f0b5f39db006e79b18f3c9d1e6134a677bCONTRIBUTING.md: Document X X X convention2023-03-30T15:31:36ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-24T18:46:17Zurn:sha1:8882df7c5118a33e684f103629cf480f7d664bb4
The placement in the "Where are some good places to start hacking?"
section is rather awkward, but I didn't see where else to put it.
CONTRIBUTING.md: Add more notes about TODOs2023-03-30T15:31:36ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-24T18:42:43Zurn:sha1:ee9486f52de80b9a084b11d63f58055da918910d
The placement in the "Where are some good places to start hacking?"
section is rather awkward, but I didn't see where else to put it.
CONTRIBUTING.md: Discourage contributors from rebasing2023-03-30T15:31:36ZIan Jacksonijackson@chiark.greenend.org.uk2023-03-24T18:39:00Zurn:sha1:a55ed63c6c5b9bf08532178251d076456d4668a5doc: mention `maint/check_env` in CONTRIBUTING.md2023-02-24T17:32:06ZEmil Englerme@emilengler.com2023-02-22T17:52:18Zurn:sha1:4f5170e6f02b98839f2938efe7acf156461fcda5