Home

Welcome to the almond wiki!

This project serves as a control system for a hydroponics farm where the users will be able to monitor and control remotely their farm and have optimal growth and use of resources.

Checklist For Reviewing Pull Requests

---

Code analysis

• Does my code follow the team's convention as regards

  1. Namings

     Do my variables, functions, classnames, test titles, components, and filenames perfectly describe what they are meant to do?

  2. Ordering

     Are my imports appropriately ordered as outlined in the wiki?

• Did I repeat any code that could have been abstracted and concise?

• Is there a section of code that I could have made re-usable?

• Is my code properly documented?

• Did I re-invent the wheel for any section of code instead of leveraging existing functionality?

Branch

• Did I rebase my branch from develop to avoid conflict?
• Does my branch name pattern match with the team's branch naming convention?

Commit Message

• Does my PR have more than five commit messages? If yes, are all of them necessary or can they be squashed to be less than 5 key commits?
• Does my commit message follow the outlined team convention?

Pull Request

• Does my PR title match the outlined team convention guide?
• Is my PR body based off the template provided for raising a PR?

Tests and Checks

• Are my tests passing on my local machine and on CircleCI?
• Are my tests displaying errors on the console?
• Does Code Climate check my code as All good?
• Are all the checks on my PR marked as successful?

Labels

• Does my PR have a Finished label attached to it?

Conflicts

• Does my PR conflict with the develop branch? If yes, Resolve it immediately!