From 973a8971c050a0ed2dd8c9dd08a8733bc37f0407 Mon Sep 17 00:00:00 2001 From: Sayan Nandan Date: Tue, 13 Oct 2020 20:54:43 +0530 Subject: [PATCH] Improve docs --- CONTRIBUTING.md | 12 +++++++++--- CONTRIBUTORS.md | 2 +- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a599d9c2..5274ed6a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,7 +1,7 @@ # 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 report bugs, send suggestions 💡 and contribute code to move this project forward ⏩. +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 report bugs, send suggestions and contribute code to move this project forward. You can see a list of contributors **[here](./CONTRIBUTORS.md)** @@ -13,13 +13,19 @@ You can see a list of contributors **[here](./CONTRIBUTORS.md)** ## Coding guidelines 👩‍💻 👨‍💻 -### Conventions +### Special comments * `FIXME(@)` : Use this when you have made an implementation that can be improved in the future, such as improved efficiency * `HACK(@)` : Use this when the code you are using a temporary workaround * `TODO(@)` : Use this when you have kept something incomplete * `UNSAFE(@)` : Use this to explain why the `unsafe` block used is safe +### Comment style + +We prefer to use a 'mixed' commenting style: a cross between the C and C++ styles. +Generally, if a comment can be explained in one-line, then follow the C++ commenting style. +In other cases, use the C style. + ### Formatting * All Rust code should be formatted using `rustfmt` diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index beed10c2..90e20e4b 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,4 +1,4 @@ # Contributors -These amazing people have contributed to the TerrabaseDB: (Sorted by number of contributions) +These amazing people have contributed to TerrabaseDB: (Sorted by number of contributions) 1. Sayan Nandan <>