Skip to content

Commit

Permalink
Vulnerability Fix
Browse files Browse the repository at this point in the history
Contribution guidelines.
  • Loading branch information
elarroba committed Sep 5, 2021
1 parent 5f61251 commit f3ed1e9
Show file tree
Hide file tree
Showing 4 changed files with 36 additions and 12 deletions.
23 changes: 23 additions & 0 deletions Contribute.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Django Ledger Contribution Guidelines

* UI
* Django Ledger UI is based on the [Bulma](https://bulma.io/) CSS Framework via [WebPack](https://webpack.js.org/).
Any template contributions must follow Bulma's best practices.
* Icons are implemented through [Iconify](https://iconify.design/) and Django Ledger has the built-in template tag
[icon](https://github.com/arrobalytics/django-ledger/blob/5f61251ce3ee8a9b159211a98d8d00c53b5cb942/django_ledger/templatetags/django_ledger.py#L78)
which can be used to render any icon using Iconify.
* JavaScript
* Django Ledger uses [TypeScript](https://www.typescriptlang.org/) to ship JavaScript to the browser. Webpack is used to bundle all CSS/JS into two
javascript files respectively. See [bundle](https://github.com/arrobalytics/django-ledger/tree/develop/django_ledger/static/django_ledger/bundle)
in the static file directory. The build command in the [assets/package.json](https://github.com/arrobalytics/django-ledger/blob/develop/assets/package.json)
file will build styles and javascript and
automatically update the application bundle with the latest compiled version.
* Models
* Changes and contributions to Models are limited to those with proven Django experience. Also, in addition to Django
experience, some accounting and domain knowledge is required. Changes to models must be justified and susbtantiated
with proper accounting best practices.
* Documentation
* All documentation contributions are welcome. [Sphinx](https://github.com/sphinx-doc/sphinx) has been set up to
automatically generate static HTML documentation.
* Unit Tests
* All unit tests contributions are welcome if they are intended to validate program logic and/or accounting logic.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ v1.0 [Roadmap](https://github.com/arrobalytics/django-ledger/blob/develop/ROADMA

__This project is actively looking for contributors. Any financial and/or accounting experience is a big plus.__
If you have prior accounting experience and want to contribute, don't hesitate to contact me.
See __[contribution guidelines](https://github.com/arrobalytics/django-ledger/blob/develop/Contribute.md)__.

## Quick Start

Expand Down
4 changes: 2 additions & 2 deletions assets/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"@types/chart.js": "^2.9.31",
"@types/lodash": "^4.14.168",
"animate.css": "^4.1.1",
"axios": "^0.21.1",
"bulma": "^0.9.2",
"axios": "^0.21.3",
"bulma": "^0.9.3",
"bulmaswatch": "^0.8.1",
"chart.js": "^2.9.4",
"pikaday": "^1.8.2",
Expand Down
20 changes: 10 additions & 10 deletions assets/yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -327,12 +327,12 @@ aws4@^1.8.0:
resolved "https://registry.yarnpkg.com/aws4/-/aws4-1.11.0.tgz#d61f46d83b2519250e2784daf5b09479a8b41c59"
integrity sha512-xh1Rl34h6Fi1DC2WWKfxUTVqRsNnr6LsKz2+hfwDxQJWmrx8+c7ylaqBMcHfl1U1r2dsifOvKX3LQuLNZ+XSvA==

axios@^0.21.1:
version "0.21.1"
resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.1.tgz#22563481962f4d6bde9a76d516ef0e5d3c09b2b8"
integrity sha512-dKQiRHxGD9PPRIUNIWvZhPTPpl1rf/OxTYKsqKUDjBwYylTvV7SjSHJb9ratfyzM6wCdLCOYLzs73qpg5c4iGA==
axios@^0.21.3:
version "0.21.3"
resolved "https://registry.yarnpkg.com/axios/-/axios-0.21.3.tgz#f85d9b747f9b66d59ca463605cedf1844872b82e"
integrity sha512-JtoZ3Ndke/+Iwt5n+BgSli/3idTvpt5OjKyoCmz4LX5+lPiY5l7C1colYezhlxThjNa/NhngCUWZSZFypIFuaA==
dependencies:
follow-redirects "^1.10.0"
follow-redirects "^1.14.0"

balanced-match@^1.0.0:
version "1.0.2"
Expand Down Expand Up @@ -382,7 +382,7 @@ buffer-from@^1.0.0:
resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5"
integrity sha512-E+XQCRwSbaaiChtv6k6Dwgc+bx+Bs6vuKJHHl5kox/BaKbhiXzqQOwK4cO22yElGp2OCmjwVhT3HmxgyPGnJfQ==

bulma@^0.9.2:
bulma@^0.9.3:
version "0.9.3"
resolved "https://registry.yarnpkg.com/bulma/-/bulma-0.9.3.tgz#ddccb7436ebe3e21bf47afe01d3c43a296b70243"
integrity sha512-0d7GNW1PY4ud8TWxdNcP6Cc8Bu7MxcntD/RRLGWuiw/s0a9P+XlH/6QoOIrmbj6o8WWJzJYhytiu9nFjTszk1g==
Expand Down Expand Up @@ -821,10 +821,10 @@ find-up@^4.0.0:
locate-path "^5.0.0"
path-exists "^4.0.0"

follow-redirects@^1.10.0:
version "1.14.2"
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.2.tgz#cecb825047c00f5e66b142f90fed4f515dec789b"
integrity sha512-yLR6WaE2lbF0x4K2qE2p9PEXKLDjUjnR/xmjS3wHAYxtlsI9MLLBJUZirAHKzUZDGLxje7w/cXR49WOUo4rbsA==
follow-redirects@^1.14.0:
version "1.14.3"
resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.14.3.tgz#6ada78118d8d24caee595595accdc0ac6abd022e"
integrity sha512-3MkHxknWMUtb23apkgz/83fDoe+y+qr0TdgacGIA7bew+QLBo3vdgEN2xEsuXNivpFy4CyDhBBZnNZOtalmenw==

forever-agent@~0.6.1:
version "0.6.1"
Expand Down

0 comments on commit f3ed1e9

Please sign in to comment.