Commit Graph

28 Commits

Author SHA1 Message Date
rl1987
b4aeeb77ba Merge advice from this_not_that.md in torguts repo into our main coding standard doc 2019-09-25 17:15:12 +03:00
teor
ac5753d3ca
Coding Standards: Document how to find git commits
Document how to find git commits and tags for bug fixes in
CodingStandards.md.

And update some changes file documentation.

Closes ticket 30261.
2019-04-23 10:03:18 +10:00
Nick Mathewson
4793d91350 Describe "check-includes" in the CodingStandards.md file 2018-07-10 11:09:25 -04:00
Nick Mathewson
fa2d53aa6a Stop mentioning src/or and src/common in doc/HACKING 2018-07-10 11:03:45 -04:00
Nick Mathewson
9af6c48d24 remove EOL@EOF advice 2018-06-18 16:18:44 -04:00
juga0
cc09ff253e Add explanation about editorconf in coding standards
so that developers know what is .editorconfig for.
2018-06-11 21:29:40 +00:00
Nick Mathewson
f7949a440f Add a CONTRIBUTING file
This file contains pointers to other important top-level resources,
and some info about acceptable licenses.  Also, add that info to
CodingStandards.md
2018-05-11 13:19:37 -04:00
teor
7b59199663
Fix a typo in CodingStandards.md
Closes #24596.
2017-12-12 12:32:50 +11:00
Nick Mathewson
7ca5f4bf03 document our allocator conventions 2017-12-08 14:47:19 -05:00
Nick Mathewson
cbea334d6b Mention even more about changes files in doc/HACKING 2017-09-22 15:14:36 -04:00
Nick Mathewson
2032d7ca6f Update CodingStandards.md for changes-file stuff
'check-changes' is now part of "make check", and must pass.
2017-09-21 16:39:49 -04:00
Taylor Yu
55fef0534d Add guidelines for floating point use 2017-09-08 12:15:41 -05:00
Nick Mathewson
8421756da3 Talk about assertions in CodingStandards.md 2017-09-07 09:37:39 -04:00
Nick Mathewson
18115b5aa9 Document some operators usage conventions. 2017-08-01 10:50:52 -04:00
Matt Traudt
d730449ba2 Add more details about git branch use in tor 2017-07-10 14:02:11 -04:00
Nick Mathewson
9e317641f9 impact -> affect 2017-07-10 10:03:45 -04:00
Chelsea H. Komlo
934f85f87a
specify when to run make distcheck 2017-07-09 16:17:21 -04:00
Chelsea H. Komlo
24d29c7ae0
make check is required for all code submissions
integration tests should be run for feature changes/major patches
2017-06-28 20:40:15 -04:00
Chelsea H. Komlo
dfde58db6b
check-spaces is run as part of make check 2016-12-21 17:08:06 -05:00
Chelsea H. Komlo
d95678ca8f
make distcheck should be a part of the local development process 2016-12-21 17:05:18 -05:00
Chelsea H. Komlo
064b1b6d1c
Adds standard to run code changes against test suite 2016-12-21 09:44:44 -05:00
J. Ryan Stinnett
231564ee5b Document no changes file needed for bugfixes on unreleased code
Fixes #20932.
2016-12-08 16:48:00 -10:00
Nick Mathewson
771ca7c544 Stop recommending --enable-gcc-warnings in doc/HACKING 2016-05-23 14:40:27 -04:00
Nick Mathewson
311a13220c mention lintChanges.py in the coding standards 2016-02-01 16:47:47 -05:00
cypherpunks
816207511b Remove the INLINE coding standard 2015-12-15 11:34:00 -05:00
Nick Mathewson
5a37061885 Delete trailing whitespace in md files 2015-11-05 09:53:05 -05:00
tom lurge
617e0f8d26 added some markdown formatting 2015-11-05 09:13:53 -05:00
Nick Mathewson
92a6c578d7 hacking is now markdown
Not good markdown, mind you.
2015-10-29 10:31:38 -04:00