nihilist/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2024-11-28 06:13:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Merge remote-tracking branch 'chelseakomlo/documentation_integ_tests'

Browse Source
This commit is contained in:
Nick Mathewson 2017-03-14 11:32:53 -04:00
commit 99ec44de45
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
doc/HACKING/CodingStandards.md
View File

@ -4,9 +4,10 @@ Coding conventions for Tor
tl;dr: tl;dr:
- Run configure with `--enable-fatal-warnings` - Run configure with `--enable-fatal-warnings`
- Run `make check-spaces` to catch whitespace errors
- Document your functions - Document your functions
- Write unit tests - Write unit tests
- Run `make test-full` to test against all unit and integration tests.
- Run `make distcheck` to ensure the distribution works
- Add a file in `changes` for your branch. - Add a file in `changes` for your branch.
Patch checklist Patch checklist
@ -22,10 +23,12 @@ preference)
Did you remember... Did you remember...
- To build your code while configured with `--enable-fatal-warnings`? - To build your code while configured with `--enable-fatal-warnings`?
- To run `make check-spaces` on your code?
- To run `make check-docs` to see whether all new options are on - To run `make check-docs` to see whether all new options are on
the manpage? the manpage?
- To write unit tests, as possible? - To write unit tests, as possible?
- To run `make test-full` to test against all unit and integration tests (or
`make test-full-online` if you have a working connection to the internet)?
- To test that the distribution will actually work via `make distcheck`?
- To base your code on the appropriate branch? - To base your code on the appropriate branch?
- To include a file in the `changes` directory as appropriate? - To include a file in the `changes` directory as appropriate?