{"id":37610897,"url":"https://github.com/brsynth/coding-guidelines","last_synced_at":"2026-01-16T10:20:42.761Z","repository":{"id":109125104,"uuid":"301428207","full_name":"brsynth/Coding-Guidelines","owner":"brsynth","description":"Coding Guidelines","archived":false,"fork":false,"pushed_at":"2020-10-06T12:20:09.000Z","size":6,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-09T20:14:15.352Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/brsynth.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2020-10-05T14:03:10.000Z","updated_at":"2020-10-06T12:20:12.000Z","dependencies_parsed_at":"2023-03-23T13:19:17.532Z","dependency_job_id":null,"html_url":"https://github.com/brsynth/Coding-Guidelines","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/brsynth/Coding-Guidelines","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brsynth%2FCoding-Guidelines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brsynth%2FCoding-Guidelines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brsynth%2FCoding-Guidelines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brsynth%2FCoding-Guidelines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/brsynth","download_url":"https://codeload.github.com/brsynth/Coding-Guidelines/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/brsynth%2FCoding-Guidelines/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28478049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T06:30:42.265Z","status":"ssl_error","status_checked_at":"2026-01-16T06:30:16.248Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-01-16T10:20:42.056Z","updated_at":"2026-01-16T10:20:42.739Z","avatar_url":"https://github.com/brsynth.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coding Guidelines\nThese guidelines aim to have a good and standardized way to write and commit code.\n\n* [Coding Python](#coding-python)\n  * [Module](#module)\n* [Committing](#committing)\n   * [Prerequisites](#prerequisites)\n      * [(Optional) (macOS) Install brew](#optional-macos-install-brew)\n      * [(Optional) Install npm](#optional-install-npm)\n      * [Install Commitizen](#install-commitizen)\n   * [Init project folder](#init-project-folder)\n      * [Seamless](#seamless)\n   * [Commit](#commit)\n\n\n\n## Coding Python\n### Module\nEach tool created in the team has to be as a Python module: easy to install, easy to deploy. A skeleton is available at https://github.com/brsynth/module.\n\n## Committing\nHaving good (browseable and readable) commits guarantees a reliable collaborative work in space and time. To address this topic, we use Commitizen to have standardized and readable commits in our projects.\n\n### Prerequisites\n\n#### (Optional) (macOS) Install brew\n```sh\n/bin/bash -c \"$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)\"\n```\n\n#### (Optional) Install npm\n- On macOS: `brew install npm`\n- On Debian-like: `apt-get install npm`\n- On Alpine-like: `apk add npm`\n\n#### Install Commitizen\n```sh\nnpm install commitizen -g\n```\n\n### Init project folder\n```sh\nnpm init\ncommitizen init cz-conventional-changelog --save-dev --save-exact\n```\n\n#### Seamless\nTo avoid footprint in the project repository, add npm files into the `.gitignore` file:\n```\npackage.json\npackage-lock.json\nnode_modules\n```\n\n### Commit\nReplace your usual commit command (e.g. `git commit -am`) by:\n```sh\ngit cz -am\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrsynth%2Fcoding-guidelines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrsynth%2Fcoding-guidelines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrsynth%2Fcoding-guidelines/lists"}