Chore/add python linter

KalleChen commented 1 year ago

Fixes #4 #5

Why do we need this PR?

Add python linter rule
Add CI workflow

How did you address the issue?

Add flake8 linter rule
Add github action workflow for CI
Add pre-commit for flake8
Add README.md document
Add PR template

PR readiness check list

[x] Did it pass the lint check?

[x] Did you test this PR?

[x] Did you explain the changes clearly?

[x] Did you reference the correct issues?

gitguardian[bot] commented 1 year ago

⚠️ GitGuardian has uncovered 3 secrets following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secrets in your pull request

| GitGuardian id | Secret | Commit | Filename | | | -------------- | ------------------------- | ---------------- | --------------- | -------------------- | | [8236603](https://dashboard.gitguardian.com/incidents/8236603?occurrence=116303030) | Django Secret Key | f7bcf9454fc6e289480889cd1664bf3fdd25093c | backend/src/settings.py | [View secret](https://github.com/KalleChen/FinBuddy/commit/f7bcf9454fc6e289480889cd1664bf3fdd25093c#diff-4ebb2dca867e34d3dc6650f04231a53436b5bf1745e9efd5dfba4581bb791c66R23) | | [8236603](https://dashboard.gitguardian.com/incidents/8236603?occurrence=116303031) | Django Secret Key | f7bcf9454fc6e289480889cd1664bf3fdd25093c | backend/src/settings.py | [View secret](https://github.com/KalleChen/FinBuddy/commit/f7bcf9454fc6e289480889cd1664bf3fdd25093c#diff-4ebb2dca867e34d3dc6650f04231a53436b5bf1745e9efd5dfba4581bb791c66L23) | | [8236603](https://dashboard.gitguardian.com/incidents/8236603?occurrence=116325168) | Django Secret Key | b61268ce9b040577071f70f2081eb0345beec0f8 | backend/src/settings.py | [View secret](https://github.com/KalleChen/FinBuddy/commit/b61268ce9b040577071f70f2081eb0345beec0f8#diff-4ebb2dca867e34d3dc6650f04231a53436b5bf1745e9efd5dfba4581bb791c66L23) |

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code. 2. Replace and store your secrets safely. [Learn here](https://blog.gitguardian.com/secrets-api-management?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) the best practices. 3. Revoke and [rotate these secrets](https://docs.gitguardian.com/secrets-detection/detectors/specifics/secret_key_in_django_config#revoke-the-secret?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). 4. If possible, [rewrite git history](https://blog.gitguardian.com/rewriting-git-history-cheatsheet?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment). Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data. To avoid such incidents in the future consider - following these [best practices](https://blog.gitguardian.com/secrets-api-management/?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) for managing and storing secrets including API keys and other credentials - install [secret detection on pre-commit](https://docs.gitguardian.com/ggshield-docs/integrations/git-hooks/pre-commit?utm_source=product&utm_medium=GitHub_checks&utm_campaign=check_run_comment) to catch secret before it leaves your machine and ease remediation.

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.

Our GitHub checks need improvements? Share your feedbacks!}

KalleChen commented 1 year ago

GitGuardian could be regardless here

KalleChen / FinBuddy