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

Update README.md

Browse source
This commit is contained in:
dannydannydanny 2021-04-21 10:18:50 +02:00 • committed by GitHub
parent 42f509a2ad
commit 3a1489f28b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 13 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
README.md
View file

@ -100,6 +100,19 @@ Context:
[coverage-badge]: https://img.shields.io/badge/Coverage-100%25-brightgreen.svg [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|
## Other methdology ## Other methdology
* [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/)
* Follow [naming conventions](https://visualgit.readthedocs.io/en/latest/pages/naming_convention.html) * Follow [naming conventions](https://visualgit.readthedocs.io/en/latest/pages/naming_convention.html)