Author: Peak AI Created: 2019-07-09 Template Version: 1
This project contains code for Peak's API.
A guide on using this template can be found here.
Provide a list of high-level dependencies (e.g. languages, frameworks) that are required for this project. Put your package requirements in a separate file.
Give steps for testing the API here. Keep it minimal.
Compliance with the below style guides is mandatory. Wherever possible, automated tools should be used to validate your code.
- Python: PEP-0008 & PEP-0257.
- JavaScript: ES6 & Peak Rules.
- R: tidyverse.
- Go: Go Styleguide.
- C/C++: Google Styleguide.
- Scala: Standard Scala Style.
- Pull the latest changes from git:
git pull. - Checkout the default branch of the repo (develop):
git checkout develop. - Branch of the default branch for your feature with:
git checkout -b <TICKET_NAME/FEATURE_NAME>/some-description. - Carry out any work on this branch.
- Add any new files with
git add my-file(for single files), orgit add -Ato add all files in a given repo. - Commit any changes with
git commit -m 'my informative description. - When ready to merge back into develop, make a PR and request a review.
Beautiful is better than ugly.
Explicit is better than implicit.
Simple is better than complex.
Complex is better than complicated.
Flat is better than nested.
Sparse is better than dense.
Readability counts.
Special cases aren't special enough to break the rules.
Although practicality beats purity.
Errors should never pass silently.
Unless explicitly silenced.
In the face of ambiguity, refuse the temptation to guess.
There should be one-- and preferably only one --obvious way to do it.
Although that way may not be obvious at first unless you're Dutch.
Now is better than never.
Although never is often better than *right* now.
If the implementation is hard to explain, it's a bad idea.
If the implementation is easy to explain, it may be a good idea.
Namespaces are one honking great idea -- let's do more of those!