From 7a24b517e5085f0f5e62366f33bc9bc3296f27a6 Mon Sep 17 00:00:00 2001 From: Karuppiah Natarajan Date: Sat, 7 Mar 2020 09:53:42 +0530 Subject: [PATCH] add how tos --- how-tos.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 how-tos.md diff --git a/how-tos.md b/how-tos.md new file mode 100644 index 0000000..50dfa1c --- /dev/null +++ b/how-tos.md @@ -0,0 +1,15 @@ +# How Tos + +These are some How Tos for the project. I want to follow them for this project +1. Write tests as much as possible. This is because I want the software to be robust +2. Reuse existing code / libraries / software whenever possible to speed up development, +and to stand on the shoulders of other giants as a lot of time and effort has been put to +make them, which doesn't have to be necessarily reinvented +3. Since we are already planning to write tests, do test driven development (TDD) whenever +possible +4. For any bug reported, write a failing test first for the bug, then fix the bug to pass the test +5. Keep the software as simple as possible - not much complexity in terms of code written, +design and architecture. To do this, write as little code as possible. Unnecessary code leads to +complexity and maintenance. No code means no maintenance and no complexity :P +6. Users are the core of the software. The software should be easy to use. If user can't use it +or understand how to use it, see behvaiour and try to change the software accordingly! \ No newline at end of file