Misc changes to docs

next
Sayan Nandan 4 years ago
parent 37d4b808e1
commit 68faa43e66
No known key found for this signature in database
GPG Key ID: C31EFD7DDA12AEE0

@ -1,4 +1,5 @@
# Contribution guidelines
Firstly, thank you for your interest in contributing to this project. This project is powered by the community
and relies on hackers across the globe to contribute code to move this project forward.
@ -14,7 +15,7 @@ You can see a list of contributors **[here](./CONTRIBUTORS.md)**
### Formatting
* All Rust code should be formatted using `rustfmt`
* All Rust code should be formatted using `rustfmt`
## Steps
@ -23,4 +24,10 @@ You can see a list of contributors **[here](./CONTRIBUTORS.md)**
3. Sign the CLA (if you haven't signed it already)
4. One of the maintainers will review your patch and suggest changes if required
5. Once your patch is approved, it will be merged into the respective branch
6. Done, you're now one of the [contributors](./CONTRIBUTORS.md)!
6. Done, you're now one of the [contributors](./CONTRIBUTORS.md) 🎉
## Testing locally
1. Install rust (stable)
2. Run `cargo build --verbose && cargo test --verbose`
3. That's it!

@ -115,7 +115,7 @@ impl Connection {
let mut bufreader = BufReader::new(&mut self.stream);
let mut metaline_buf = String::with_capacity(DEF_QMETALINE_BUFSIZE);
// First read the metaline
// TODO: We will use a read buffer in the future and then do all the
// TODO(@ohsayan): We will use a read buffer in the future and then do all the
// actions below to improve efficiency - it would be way more efficient
bufreader.read_line(&mut metaline_buf).await.unwrap();
let pqmf = PreQMF::from_buffer(metaline_buf)?;

Loading…
Cancel
Save