summaryrefslogtreecommitdiff
path: root/CONTRIBUTING.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Move Tor Browser part to arti top-level (code motion)Ian Jackson2022-09-021-46/+2
|
* add link to coverage reportstrinity-1686a2022-05-261-1/+2
|
* Remove cargo-husky, and replace with manual instructionseta2022-05-101-5/+7
| | | | | | | | A build script reaching into your .git/hooks/ and modifying them nonconsensually was a bit of a horrifying concept, and also made it hard to build arti with the feature disabled. Remove this crate, and replace it with manual instructions on how to install the hooks in CONTRIBUTING.md.
* Note the dependency on PCRE support in Git implied by the use of grep -P in ↵Steven Murdoch2022-03-081-1/+4
| | | | the git hooks
* Merge branch 'contributing-dependencies' into 'main'Ian Jackson2022-03-071-1/+7
|\ | | | | | | | | Add missing dependencies to CONTRIBUTING.md See merge request tpo/core/arti!389
| * Add more explaining textLennart Kloock2022-03-051-2/+4
| |
| * Add link to shellcheck installation guideLennart Kloock2022-03-051-1/+1
| |
| * Add required dependencies to compile `arti` and run git hooks to CONTRIBUTING.mdLennart Kloock2022-03-051-0/+4
| |
* | Add instructions for hooking up Tor Browser to arti on WindowsSteven Murdoch2022-03-041-2/+12
|/
* README,CONTRIBUTING: More links.Nick Mathewson2022-01-211-3/+8
| | | | | | | Explain how to report bugs and how get accounts on the bugtracker; add link to the troubleshooting document. Part of #277
* CONTRIBUTING: Document how to build the docsIan Jackson2022-01-201-0/+2
| | | | Eventually we may need a separate HACKING.md
* Update CONTRIBUTING to mention FIXME, not XXX.Nick Mathewson2021-12-201-1/+1
|
* Improve and future-proof the `arti` CLIeta2021-10-271-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | This switches out `arti`'s argument-parsing library with `clap`, which is a lot more featureful (and very widely used within the Rust ecosystem). We also now use a lot of `clap`'s features to improve the CLI experience: - The CLI now expects a subcommand (currently, either "help", or "proxy" for the existing SOCKS proxy behaviour). This should let us add additional non-SOCKS-proxy features to arti in future. - `clap` supports default values determined at runtime, so the way the default config file is loaded was changed: now, we determine the OS-specific path for said file before invoking `clap`, so the help command can show it properly. - The behaviour of `tor_config` was also changed; now, one simply specifies a list of configuration files to load, together with whether they're required. - That function also way overused generics; this has been fixed. - Instead of using the ARTI_LOG environment variable to configure logging, one now uses the `-l, --log-level` CLI option. (The intent is for this option to be more discoverable by users.) - The `proxy` subcommand allows the user to override the SOCKS port used on the CLI without editing the config file.
* Fix typos and cleanupDimitris Apostolou2021-10-251-1/+1
|
* Create a separate logging section in config.Jani Monoses2021-09-091-1/+1
|
* More flexible tracing configuration.Jani Monoses2021-08-261-1/+1
| | | | | | | | | | | | | Replace the trace config file option with a more flexible trace_filter and expose the same via the ARTI_LOG environment variable. If ARTI_LOG is set it will override the setting in the config file. Example: ARTI_LOG="info,tor_proto::channel=trace" ./target/debug/arti The syntax is described here https://docs.rs/tracing-subscriber/0.2.20/tracing_subscriber/filter/struct.EnvFilter.html#directives
* Move MSRV note to READMENick Mathewson2021-08-241-5/+0
|
* Add a quick MSRV note.Nick Mathewson2021-08-241-0/+5
|
* Light edits on CONTRIBUTING.mdNick Mathewson2021-08-091-9/+21
| | | | | | | | | | | | | Mainly, drop the suggestion to fetch submodules, and explain what more things do. (The only submodule we have now is the fuzzing corpora, which most people won't want.) (I am not 100% convinced that we should keep 100% of the instructions for working with git in the long term. Do many other projects have these? Is there a tutorial we should link to instead?)
* WIP: Add development environment setup tipsS0AndS02021-08-061-0/+63
|
* Add OSX instructions to CONTRIBUTING.mdNick Mathewson2021-07-231-1/+14
| | | | Closes #151.
* Fix typosHackerNCoder2021-06-171-1/+1
|
* Revise repository-level documentationNick Mathewson2021-06-171-8/+75
|
* Move our command-line interface into a new crate called "arti".Nick Mathewson2021-03-171-1/+1
| | | | Closes #106
* Recommend running arti build with --releaseNick Mathewson2021-02-091-2/+2
|
* Add a rough CONTRIBUTING.md file with some dogfooding instructions.George Kadianakis2021-02-081-0/+21