Skip to content

Instantly share code, notes, and snippets.

@vishalbasra
Last active August 7, 2018 21:28
Show Gist options
  • Select an option

  • Save vishalbasra/63de24dfb1013457c6ab60ef1c6c9a99 to your computer and use it in GitHub Desktop.

Select an option

Save vishalbasra/63de24dfb1013457c6ab60ef1c6c9a99 to your computer and use it in GitHub Desktop.

Revisions

  1. vishalbasra revised this gist Aug 7, 2018. No changes.
  2. vishalbasra renamed this gist Aug 1, 2018. 1 changed file with 0 additions and 0 deletions.
    File renamed without changes.
  3. vishalbasra renamed this gist Aug 1, 2018. 1 changed file with 0 additions and 0 deletions.
    File renamed without changes.
  4. vishalbasra revised this gist Aug 1, 2018. 1 changed file with 30 additions and 1 deletion.
    31 changes: 30 additions & 1 deletion gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -8,4 +8,33 @@ The **goal** for this is to make me write better readable code and to also make


    - Does the brnach name, PR name makes sense?
    - Is the PR / branch linked to a ticket, is there a ticket?
    - Is the PR / branch linked to a ticket, is there a ticket?
    - Do the commit mesages make sense, will I be able to read my commit message a year later and understand why that commit was made?
    - Is this a feature / bugfix ? Is that documented well enough?



    - Does the code follow semantics guidelines - linting, best practices etc?
    - What does the code do - is it simple enought to read and understand?
    - Are we trying to follow naming convention throughout eg: `a-b-c` vs `a.b.c` etc, is that followed?
    - Are we being alphabetic / ascending where we can be? eg: Add 4 disks of 40,30,85 and 10 GB, it's better to add them in the ascending order. Same for the alphabetic order. Are we doing this where possible?
    - Do variable , function names etc make senes, are they readable, follow the same naming convention, order?
    - Is there a `TODO` or a `NOTES` thing?


    - Is the code testable, if not, can we make it testable? If yes, do the tests pass?
    - Are there any third-part dependencies?
    - Have any of the dependencies changes?
    - Is something cached that makes it *look like the code is working* but taking that away actually breaks things?


    - **Can this break things?**
    - **Has this been tested in a throw-away / lower environment**
    - **What will this code affect, is it an entire environment? If so, can we limit it?**
    - **Does this warrant a business head's approval?**
    - **What's the worse that could happen?**
    - **What's teh best that could happen?**
    - **What's most likely to happen?**
    - **Analyze risk v/s the need to push this code**
    - **What's a good time to push this code?'**
    - **Who all need's to be informed about this code?**
  5. vishalbasra revised this gist Aug 1, 2018. 1 changed file with 2 additions and 0 deletions.
    2 changes: 2 additions & 0 deletions gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,7 @@
    # Good coding practices or review **Guidelines**
    <br>


    The **goal** for this is to make me write better readable code and to also make me a better reviewer

    <br>
  6. vishalbasra revised this gist Aug 1, 2018. 1 changed file with 7 additions and 1 deletion.
    8 changes: 7 additions & 1 deletion gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -1,3 +1,9 @@
    # Good coding practices or review **Guidelines**
    <br>
    ##
    The **goal** for this is to make me write better readable code and to also make me a better reviewer

    <br>


    - Does the brnach name, PR name makes sense?
    - Is the PR / branch linked to a ticket, is there a ticket?
  7. vishalbasra revised this gist Aug 1, 2018. 1 changed file with 2 additions and 1 deletion.
    3 changes: 2 additions & 1 deletion gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -1,2 +1,3 @@
    # Good coding practices or review **guidelines**
    # Good coding practices or review **Guidelines**
    <br>
    ##
  8. vishalbasra revised this gist Aug 1, 2018. 1 changed file with 2 additions and 9 deletions.
    11 changes: 2 additions & 9 deletions gistfile1.md
    Original file line number Diff line number Diff line change
    @@ -1,9 +1,2 @@
    Me test


    ```
    I am code
    ```


    `I am groot`
    # Good coding practices or review **guidelines**
    ##
  9. vishalbasra renamed this gist Aug 1, 2018. 1 changed file with 0 additions and 0 deletions.
    File renamed without changes.
  10. vishalbasra revised this gist Aug 1, 2018. 1 changed file with 4 additions and 0 deletions.
    4 changes: 4 additions & 0 deletions gistfile1.txt
    Original file line number Diff line number Diff line change
    @@ -1,5 +1,9 @@
    Me test


    ```
    I am code
    ```


    `I am groot`
  11. vishalbasra created this gist Aug 1, 2018.
    5 changes: 5 additions & 0 deletions gistfile1.txt
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,5 @@
    Me test
    ```
    I am code
    ```
    `I am groot`