201 lines
9.3 KiB
Markdown
201 lines
9.3 KiB
Markdown
## [DannyDannyDanny/Methodology](https://github.com/DannyDannyDanny/methodology/)
|
|
|
|
<a href="https://gitmoji.carloscuesta.me">
|
|
<img src="https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=flat-square" alt="Gitmoji">
|
|
</a>
|
|
|
|
## Repo Roadmap
|
|
* [x] 2021Q1: ~Gitmoji -> (general) Methodology~ :white_check_mark:
|
|
* [x] 2021Q2: ~Version control methodology~
|
|
* 2021Q3: Decide on sections
|
|
* [ ] Python section
|
|
* [ ] Organize [other methodology](#other-methdology) into hierarchy
|
|
* [ ] Split hierarchy into paragraphs / sections
|
|
* 2021Q4
|
|
* [ ] Refine github flows
|
|
* [ ] Add sub-pages
|
|
* [ ] Add [Custom utils](https://dev.to/kenbellows/a-few-python-repl-config-tricks-3o6i).
|
|
* [ ] 2022Q1 Consultancy Method
|
|
|
|
|
|
This methodology repo is focused on Python Data Processing based projects with som external dependencies (APIs or DBs). The repo is actively being updated; Leave a start bookmark it or _Watch_ the repo to get notificatied of updates.
|
|
|
|
# Version control
|
|
|
|
## Commit messages and `gitmoji`
|
|
|
|
Use the format `:gitmoji: <commit message>` in your commit messages. Only proper nouns, CamelCase and class names should have uppercases letters. Avoid using multiple gitmojis.
|
|
|
|
|emoji|code|description|
|
|
|---|---|---|
|
|
|:sparkles:|`:sparkles:`| add new feature / function |
|
|
|:art:|`:art:`| refactor code / improve readibility / structure and lint flake8 |
|
|
|:goal_net:|`:goal_net:`| try/raise/handle errors or warnings|
|
|
|:zap:|`:zap:`| improve performance / coverage / profiling |
|
|
|:bug:|`:bug:`| bug fixing |
|
|
|:truck:|`:truck:`| moving / renaming |
|
|
|:recycle:|`:recycle:`| work related to CI/CD, webhooks, automated tests |
|
|
|:boom:|`:boom:`| work in progress / breaking changes |
|
|
|:memo:|`:memo:`| doc / logging / verbosity / code comments |
|
|
|:fire: |`:fire:`| remove (dead) code / file |
|
|
|:alien:|`:alien:`| changes related to APIs and Databases |
|
|
|:tada:|`:tada:`| clean / transform / validate _data_|
|
|
|:lipstick:|`:lipstick:`| improve UI / UX, CLI or visualizations|
|
|
|:brain:|`:brain:`| statistical modelling, training and prediction|
|
|
|:pushpin:|`:pushpin:`| dependency and environment versioning |
|
|
|:see_no_evil:|`:see_no_evil:`| changes to .gitignore and exclusively local files |
|
|
|:mag: |`:mag:`| changes in connection with PR-review change-requests |
|
|
|
|
Missing a gitmoji? Get [inspiration](https://gist.github.com/rxaviers/7360908).
|
|
Submit an [issue](https://github.com/DannyDannyDanny/gitmoji/issues) (or [Pull Request](https://github.com/DannyDannyDanny/gitmoji/pulls)).
|
|
|
|
## Oneliner install and run
|
|
When using git repositories, connect with [ssh](https://stackoverflow.com/a/65415202/5684214).
|
|
|
|
The README for your project should contain a one-liner code that dowloads, installs and runs a mini-test.
|
|
```bash
|
|
git clone https://github.com/user/repo.git cool-repo && cd cool-repo
|
|
pipenv install
|
|
pipenv run python .
|
|
#cd .. && rm -rf cool-user-repo-online
|
|
```
|
|
|
|
## Git Flows
|
|
|
|
> In progress! 🚧 Use [git hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)!
|
|
|
|
```sh
|
|
# Git Log A DOG acronym
|
|
git log --all --decorate --oneline --graph
|
|
|
|
# when you have uncommitted changes
|
|
git add --patch <pattern>
|
|
|
|
# check what you've staged
|
|
git diff --cached
|
|
|
|
# NEW DEVELOPMENT FLOW
|
|
# clone repo with local_name enables several clones
|
|
git clone <repo> <local_name>
|
|
|
|
# optional: checkout (i.e switch to) a branch to continue developing from there
|
|
git checkout <feature/featurename>
|
|
|
|
# optional if you switched branch on the last step
|
|
# switched branch: branch out from
|
|
git checkout <feature/newfeature>
|
|
git branch <feature/newfeature>
|
|
git push --set-upstream origin <feature/newfeature>
|
|
|
|
# delete branch locally (-d: normal, -D: force)
|
|
git branch -D <branch_name_1> <branch_name_2> <branch_name_1>
|
|
# delete remote
|
|
git push origin -d <branch_name>
|
|
|
|
# Comparing / Merging two branches
|
|
git merge --no-commit --no-ff <feature/otherfeaturebranch>
|
|
|
|
# get file from another branch
|
|
git checkout <otherbranch> -- path/to/dir
|
|
|
|
# delete branches not present on remote
|
|
git remote prune origin
|
|
|
|
# see all commits that affected somefile
|
|
git log --follow -- filename
|
|
|
|
# search code in all history
|
|
git log -S "some_old_varname" --oneline --all
|
|
```
|
|
|
|
#### Submitting multiple PRs
|
|
* [Interactive rebase](https://stackoverflow.com/questions/35790561/working-while-waiting-for-pending-pr#comment96514430_35793095)
|
|
* [Rebase & Update PR](https://www.digitalocean.com/community/tutorials/how-to-rebase-and-update-a-pull-request)
|
|
|
|
Context:
|
|
1. submit PR for _feature1_
|
|
2. from _feature1_ branch make new branch _feature2_
|
|
3. commit and push _feature2_ changes
|
|
4. submit PR
|
|
5. Both PRs approved
|
|
|
|
```
|
|
# there should be one or more flows that account for cases where:
|
|
# -> feature1 gets change requests
|
|
# -> feature1 is rejected and made obsolete
|
|
```
|
|
|
|
# Python
|
|
Packages we like:
|
|
* Python Standard Library:
|
|
* [argparse](https://docs.python.org/3/library/argparse.html) to build CLI programs
|
|
* [pipx](https://pypi.org/project/pipx/) or [pyenv](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/).
|
|
environment management.
|
|
* [Fabric](https://www.fabfile.org/) for deployment over SSH
|
|
|
|
### Pathlib
|
|
For navigating, reading and filesystem and file read/write.
|
|
```
|
|
from pathlib import Path
|
|
Path('.').iterdir()
|
|
Path('.').absolute()
|
|
```
|
|
|
|
# Documentation
|
|
* Use [Google's Markdown Style Guide](https://google.github.io/styleguide/docguide/style.html) for written documentation.
|
|
* Conceptual graphical documentation as inline embedded images.
|
|
* Save Matplotlib / Seaborn plots as `.svg`.
|
|
* Sketches and handwritten illustrations scanned / photographed as `.png`/`.jpg`.
|
|
* Scanned / photographed illustrations should be cropped, contrast and alligned.
|
|
|
|
## Other methdology
|
|
* [Things you should do now](https://secure.phabricator.com/book/phabflavor/article/things_you_should_do_now/)
|
|
* Follow [naming conventions](https://visualgit.readthedocs.io/en/latest/pages/naming_convention.html)
|
|
* Follow [software engineering laws](https://www.netmeister.org/blog/software-engineering-laws.html)
|
|
* Planning
|
|
* [non-linear roadmaps](https://productcrunch.substack.com/p/escaping-the-roadmap-trap)
|
|
* DevOps
|
|
* Do [CodeReviews](https://softwareengineering.stackexchange.com/questions/141005/how-would-you-know-if-youve-written-readable-and-easily-maintainable-code/141010#141010)
|
|
* Use [scrum methodology](https://www.scruminc.com/scrum-glossary/)
|
|
* Test and Production environments must be the same and very well defined: FreeBSD image or Ubunut Docker container
|
|
* UX/UI
|
|
* [Understand, Ideate and Test, Implement](https://uxtools.co/challenges/) UX.
|
|
* [Divide year into 26 fortnights labelled A-Z](https://futureofcoding.org/episodes/044#19)
|
|
* Avoid [dark patterns](https://darkpatterns.org/types-of-dark-pattern.html)
|
|
* Visualization
|
|
* problem: it's difficult to include visualization in this workflow but essential to fast prototyping.
|
|
* Perhaps [text-to-diagram](https://xosh.org/text-to-diagram/)
|
|
* [AsciiFlow](https://asciiflow.com/#/)
|
|
* *Spectral*, a [diverging colormap from matplotlib](https://matplotlib.org/3.1.0/tutorials/colors/colormaps.html#diverging).
|
|
* [Tikz Editor](https://tikzcd.yichuanshen.de)
|
|
* Database / DataWarehouse
|
|
* PostgreSQL ([datetime functs](https://www.postgresql.org/docs/9.1/functions-datetime.html))
|
|
* Consider SQL (but [don't use `select *`](https://tanelpoder.com/posts/reasons-why-select-star-is-bad-for-sql-performance/))
|
|
* Be aware of [feature casualties of large databases](https://web.dev/streams/)
|
|
* [Data Science - Hierarchy of Needs](https://hackernoon.com/the-ai-hierarchy-of-needs-18f111fcc007)
|
|
* Security
|
|
* Audit [security](https://hangar.tech/posts/our-dsq/)
|
|
* Understand [SSH tunnels](https://robotmoon.com/ssh-tunnels/)
|
|
* [Anticipatory Failure Determination](https://historyofyesterday.com/suppose-i-wanted-to-kill-a-lot-of-pilots-f126bbc756fa)
|
|
* [Secret Management for APIs](https://blog.gitguardian.com/secrets-api-management/)
|
|
* Programming Personalizations
|
|
* [git bash solarized :sun_with_face:](https://github.com/speedpacer/gitbash_solarized/issues)
|
|
* [Music for programming](https://www.musicforprogramming.net)
|
|
* [OpenStack](https://docs.openstack.org/hacking/latest/user/hacking.html#styleguide): Linting and Pre-commit Hooks
|
|
* Deploying
|
|
* Virtualize Everything! [Awesome-Compose](https://github.com/docker/awesome-compose).
|
|
* AI / ML / Modelling
|
|
* [open source cousin to GPL3](https://github.com/kingoflolz/mesh-transformer-jax)
|
|
* There's some gold nuggets this [reddit post](https://old.reddit.com/r/ExperiencedDevs/comments/nmodyl/drunk_post_things_ive_learned_as_a_sr_engineer/)
|
|
* Philosophy / Mindset / Principles
|
|
* [the-importance-of-humility-in-software-development](https://humbletoolsmith.com/2020/08/10/the-importance-of-humility-in-software-development/)
|
|
* _doing it right_ vs _doing it on time_
|
|
* Closed Source Software: If you cannot check what it does / how it works, do not use it for the sake of security.
|
|
* Collaboration / Working in a team
|
|
* Details about [pair programming](https://martinfowler.com/articles/on-pair-programming.html)
|
|
* Is [extreme programming](http://www.extremeprogramming.org/) a thing?
|
|
* Collaboration (tools: [csvbox](https://csvbox.io/), [pyodide](https://github.com/pyodide/pyodide))
|
|
* Resolve [Joel's 12 Questions](https://www.joelonsoftware.com/2000/08/09/the-joel-test-12-steps-to-better-code/)
|
|
* keeping the repo nice ![Coverage badge][coverage-badge]
|
|
|
|
[coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg
|