GlcoinCore/electrs
1
0
Fork 0
mirror of https://github.com/romanz/electrs.git synced 2026-08-13 12:32:52 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Fix grammar and wording issues in documentation (#1183)

Browse source
This commit is contained in:
leopardracer 2025-05-24 09:12:39 +03:00 • committed by GitHub
parent 0de492bf33
commit 6cb5290dc4
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 5 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

8
CONTRIBUTING.md
View file

@ -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!
Get cracking, have fun, and do ask for help when in doubt!

2
doc/cookie_deprecation.md
View file

@ -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.