dannydannydanny/methodology
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

🎨 organize sections

Browse source
This commit is contained in:
dannydannydanny 2021-08-05 13:41:21 +02:00 • committed by GitHub
parent 706db06c04
commit 582dc3fc8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 27 deletions
Download patch file Download diff file Expand all files Collapse all files

52
README.md
View file

@ -68,10 +68,8 @@ git log --all --decorate --oneline --graph
# when you have uncommitted changes # when you have uncommitted changes
git add --patch <pattern> git add --patch <pattern>
```
#### New Development Flow # NEW DEVELOPMENT FLOW
```
# clone repo with local_name enables several clones # clone repo with local_name enables several clones
git clone <repo> <local_name> git clone <repo> <local_name>
@ -83,10 +81,8 @@ git checkout <feature/featurename>
git checkout <feature/newfeature> git checkout <feature/newfeature>
git branch <feature/newfeature> git branch <feature/newfeature>
git push --set-upstream origin <feature/newfeature> git push --set-upstream origin <feature/newfeature>
```
#### Comparing / Merging two branches # Comparing / Merging two branches
```
git merge --no-commit --no-ff <feature/otherfeaturebranch> git merge --no-commit --no-ff <feature/otherfeaturebranch>
``` ```
@ -107,38 +103,30 @@ Context:
# -> feature1 is rejected and made obsolete # -> feature1 is rejected and made obsolete
``` ```
## Repo Badges # Python
> Coming soon! 🚧
![Coverage badge][coverage-badge]
[coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg
## Documentation
* Use markdown with [Google 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.
|Cons of tables |Pros of tables|
|--|--|
| Great splitting information | Painful to format in MD|
## Python
Python is notoriously painful to manage. Use [pipx](https://pypi.org/project/pipx/) or [pyenv](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/). Python is notoriously painful to manage. Use [pipx](https://pypi.org/project/pipx/) or [pyenv](https://mitelman.engineering/blog/python-best-practice/automating-python-best-practices-for-a-new-project/).
### Pathlib ### Pathlib
For navigating, reading and filesystem and file read/write.
``` ```
from pathlib import Path from pathlib import Path
Path('.').iterdir() Path('.').iterdir()
Path('.').absolute() Path('.').absolute()
``` ```
## Deploying to Servers ### Deploying to Servers
When deploying to FreeBSD and Linux servers, place the code in the `/home` directory. When deploying to FreeBSD and Linux servers, place the code in the `/home` directory.
# Documentation
* Use markdown with [Google 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 ## Other methdology
* Closed Source Software: If you cannot check what it does / how it works, do not use it for the sake of security. * Closed Source Software: If you cannot check what it does / how it works, do not use it for the sake of security.
* [Things you should do now](https://secure.phabricator.com/book/phabflavor/article/things_you_should_do_now/) * [Things you should do now](https://secure.phabricator.com/book/phabflavor/article/things_you_should_do_now/)
@ -175,5 +163,15 @@ When deploying to FreeBSD and Linux servers, place the code in the `/home` direc
* [open source cousin to GPL3](https://github.com/kingoflolz/mesh-transformer-jax) * [open source cousin to GPL3](https://github.com/kingoflolz/mesh-transformer-jax)
* [Divide year into 26 fortnights labelled A-Z](https://futureofcoding.org/episodes/044#19) * [Divide year into 26 fortnights labelled A-Z](https://futureofcoding.org/episodes/044#19)
# Project Portfolio # Sort Sections
### Repo Badges
> Coming soon! 🚧
![Coverage badge][coverage-badge]
[coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg
### Project Portfolio
* Consumption Predictor * Consumption Predictor