{"id":19134047,"url":"https://github.com/umbrellio/guidelines","last_synced_at":"2026-02-28T12:39:23.546Z","repository":{"id":115716059,"uuid":"117650501","full_name":"umbrellio/guidelines","owner":"umbrellio","description":"This manual describes the style and minimal requirements of maintaining and supporting the UMBRELLIO's github repositories.","archived":false,"fork":false,"pushed_at":"2018-04-20T07:52:45.000Z","size":11,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-13T12:03:34.035Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/umbrellio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":null,"code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2018-01-16T07:41:55.000Z","updated_at":"2020-10-29T20:00:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"25008357-7697-4735-92ae-97f7ad2a2485","html_url":"https://github.com/umbrellio/guidelines","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/umbrellio/guidelines","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fguidelines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fguidelines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fguidelines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fguidelines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umbrellio","download_url":"https://codeload.github.com/umbrellio/guidelines/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umbrellio%2Fguidelines/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29934419,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-28T12:34:16.884Z","status":"ssl_error","status_checked_at":"2026-02-28T12:34:13.721Z","response_time":90,"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":"2024-11-09T06:25:03.949Z","updated_at":"2026-02-28T12:39:23.522Z","avatar_url":"https://github.com/umbrellio.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# UMBRELLIO guidelines\n\nThis manual describes the style and minimal requirements of maintaining and supporting the UMBRELLIO's github repositories.\n\n## Table of contents:\n\n* [Github Repository Design](#github-repository-design)\n  * [Title](#title)\n  * [Description](#description)\n  * [Table of contents](#table-of-contents)\n  * [Links](#links)\n  * [Contributing / Code of Conduct](#contributing-code-of-conduct)\n  * [License / Copyright / About us](#license-copyright-about-us)\n* [Forks](#forks)\n* [External services (CI and others)](#external-services)\n* [Code style and Workflow design](#code-style-and-workflow-design)\n  * [Workflow Design](#workflow-design)\n  * [Code of Conduct and Contributing](#code-of-conduct-and-contributing-rules)\n  * [Versioning](#versioning)\n  * [Changelog](#changelog)\n* [Full Example](#full-example)\n\n## Github Repositry Design\n\n### Title\n\nMinimal description of the repository. Should describe the main objective of the project. Clear and correct formulation is needed because it affects the SEO part.\n\n### Description\n\nAn introductory description into the project with the necessary information required to quickly understand the main objective of the project.\nShould contain:\n- logo (optional);\n- minimal project statistics in the form of badge blocks that will provide an information about:\n  - current project version;\n  - current build status;\n  - current test coverage;\n- text of description.\n\n### Table of contents\n\nThe main section with project documentation in an arbitary form (can be moved to the wiki section of the github repository). Basic form:\n- Part 1. Requirements\n  - Minimal project requrements such as platform, operating system, native dependencies and etc.\n- Part 2. Installation\n  - Detailed instructions for installing the project and some specific notes.\n- Part 3. Usage\n  - The main documentation section. Arbitary form. Can be placed in the wiki section of the repository (or some of them with symlinks).\n\n### Links\n\nLinks to arcticles that refers to the current project (articles of other companies, our articles, Medium links, reddit topics and etc).\nFor the highly popular projects this section is optional.\n\n### Contributing / Code of Conduct\n\nProvide a link to our [Contributing Rules](https://github.com/umbrellio/guidelines/blob/master/CONTRIBUTING.md) (or put this file into the repo itself).\n\nProvide a link to our [Code of Conduct](https://github.com/umbrellio/guidelines/blob/master/CODE_OF_CONDUCT.md) (or put this file into the repo itself).\n\n### License / Copyright / About Us\n\nMain sections:\n- License: short description, license type, link to the license file;\n- About us: briefly shows the company ideals and the list of the project maintainers and top contributors.\n  Basic form:\n  - (required) [company logo with sponsorship label](https://github.com/umbrellio/Umbrellio);\n  - (optional) short description that describes companie's values;\n  - (required) short list of top maintainers and contributors.\n\n## Forks\n\nFork should have a changed readme: a small CHANGES section should be placed in the top of the readme file.\nThis section briefly describes the changes made to the project: purpose, reasons and functionality.\n\n## External services\n\nEach repository should correspond to the modern standards and requirements of the development processes which followed by the company in a given moment. Our requirements are: full test coverage, full compliance with code style standarts and a successful build of othe project.\nThese requirements can be achieved via:\n\n- [HoundCI](https://houndci.com/) (code style and code review)\n  - [Documentation](https://houndci.com/configuration);\n  - [rubocop integration](https://houndci.com/configuration#ruby);\n  - [eslint integration](https://houndci.com/configuration#eslint);\n  - [sass-lint integration](https://houndci.com/configuration#sass-lint);\n- [CoverAlls](https://coveralls.io/) (test coverage)\n  - [Documentation](https://docs.coveralls.io);\n  - [Ruby integration](https://docs.coveralls.io/ruby-on-rails);\n  - [JavaScript integration](https://docs.coveralls.io/javascript);\n- [TravisCI](https://travis-ci.org/) (build and test)\n  - [Introduction](https://docs.travis-ci.com/user/for-beginners/);\n  - [Ruby integration](https://docs.travis-ci.com/user/languages/ruby/);\n  - [JavaScript integration](https://docs.travis-ci.com/user/languages/javascript-with-nodejs/);\n\n## Code style and Workflow design\n\n### Workflow Design\n\nThe style of development is highly individual for each project. Workflow design should be chosen depending on the popularity and size of the project.\n\nUse [Gitflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow) for the big and popular project and typical PR-approach for the small project.\n\n### Code of Conduct and Contributing rules\n\n- Our [Code of Conduct](https://github.com/umbrellio/guidelines/blob/master/CODE_OF_CONDUCT.md);\n- Our [Contributing Rules](https://github.com/umbrellio/guidelines/blob/master/CONTRIBUTING.md);\n\n### Versioning\n\nFollow [Semver 2.0.0](https://semver.org) standard.\n- [npm semver tutorial](https://docs.npmjs.com/getting-started/semantic-versioning)\n- [ruby-gems semver tutorial](http://guides.rubygems.org/patterns/#semantic-versioning)\n\n### Changelog\n\nIt is necessary to have `CHANGELOG.md` file where you can always find out and see what changes have been made to each version of the project.\n\nFollow [KeepChangelog 1.0.0](http://keepachangelog.com/en/1.0.0/) standard.\n\n## Full Example\n\n(In active development)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumbrellio%2Fguidelines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumbrellio%2Fguidelines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumbrellio%2Fguidelines/lists"}