From 6cb5290dc415ba21e4d6b4321ef712ce84fc2843 Mon Sep 17 00:00:00 2001 From: leopardracer <136604165+leopardracer@users.noreply.github.com> Date: Sat, 24 May 2025 09:12:39 +0300 Subject: [PATCH] Fix grammar and wording issues in documentation (#1183) --- CONTRIBUTING.md | 8 ++++---- doc/cookie_deprecation.md | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6d9d1b4..7092386 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -27,13 +27,13 @@ The codebase is maintained using the "contributor workflow" where everyone without exception contributes patch proposals using "pull requests". This facilitates social contribution, easy testing and peer review. -To contribute a patch, the workflow is a as follows: +To contribute a patch, the workflow is as follows: 1. Fork repository 2. Create topic branch 3. Commit patches -Please keep commits should atomic and diffs easy to read. For this reason +Please keep commits atomic and diffs easy to read. For this reason do not mix any formatting fixes or code moves with actual code changes. Further, each commit, individually, should compile and pass tests, in order to ensure git bisect and other automated tools function properly. @@ -84,8 +84,8 @@ grammar fixes. ### Formatting -The repository currently does use `rustfmt` for all the formatting needs. Running the automated +The repository currently uses `rustfmt` for all the formatting needs. Running the automated script mentioned above would format all your code for you :) ## Ending Notes -Get cracking, have fun, and do ask for help when in doubt! \ No newline at end of file +Get cracking, have fun, and do ask for help when in doubt! diff --git a/doc/cookie_deprecation.md b/doc/cookie_deprecation.md index 953dfc0..37bec32 100644 --- a/doc/cookie_deprecation.md +++ b/doc/cookie_deprecation.md @@ -21,7 +21,7 @@ The option was confusing: If you're installing `electrs` for the first time, just don't use `cookie`. If you're updating, reconsider the motivation above. -If you used copying script, just use `cookie_file` to get the cookie directly. +If you used a copying script, just use `cookie_file` to get the cookie directly. If you also used `BindsTo`, we recommend removing it. If you used fixed username and password because you didn't know about cookie or did it before `cookie_file` was implemented, reconsider using cookie authentication. If you really have to use fixed username and password, specify them using `auth` option (`username:password` like before) and remove the `cookie` option.