viphat/pull-requests-template.md

## pull-requests-template.md

      
    Raw
  

              pull-requests-template.md
            
          
    Pull Requests Template

[STATUS (WIP/HOLD/READY)] - [TICKET_ID] - NAME OF PULL REQUEST
Related Issues

Link to JIRA’s User Story
What's this PR do?

Description - It might be same as user story, but sometimes, they might be different. For example: This PR is just a small part of User Story.

 Sub-task 1
 Sub-task 2
 Sub-task 3
 …

Steps to Test or Reproduce


Step 1
Step 2
Step 3
...

Screenshots (If appropriate)

BEFORE
AFTER
Deploy Notes

Any note about: Migrations, Rake Tasks, Install New Gems, New Environment Variables, Settings Values… need to run to make this PR works.
Self-Reviewer

General


 Does the code work as what it says?
 Is all the code easily understood?
 Is there any redundant or duplicate code?
 Is the code as modular as possible?
 Can any of the code be replaced with library functions?

Readiness


 Do you follow all coding standard? (Rubocop - Ruby, CoffeeLint - CoffeeScript, etc)
 Are your class/method/attribute name is correct (Singular/Plural/Noun/Verb/Spelling)? Do they need a better name?
 Do you need to put the method in private? Did you put the method correct place?
 Did you put comments(description, params, return) on the method that difficult to understand?

Testing


 Is the code testable?
 Do tests exist and are they comprehensive?
 Did your changes pass all tests?

Performance


 Does your code optimized for speed (SQL query, N+1, select all ...)?
 Did you check indexes of the fields on your queries?