├── .gitignore ├── .husky └── pre-commit ├── .github ├── FUNDING.yml ├── CODEOWNERS ├── ISSUE_TEMPLATE │ ├── config.yml │ ├── feature_request.yml │ └── bug_report.yml ├── workflows │ └── main.yml └── PULL_REQUEST_TEMPLATE.md ├── documents ├── incorporation_certificate.pdf └── README.md ├── .prettierrc.json ├── profile └── README.md ├── SUPPORT.md ├── tools ├── _packages.js ├── readme.js └── pwa_assets.js ├── package.json ├── BRANDING.md ├── README.md ├── CONTRIBUTING.md ├── CODE_OF_CONDUCT.md └── LICENSE /.gitignore: -------------------------------------------------------------------------------- 1 | .idea/ 2 | node_modules/ -------------------------------------------------------------------------------- /.husky/pre-commit: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | . "$(dirname "$0")/_/husky.sh" 3 | 4 | npx lint-staged 5 | -------------------------------------------------------------------------------- /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | github: [sign] # https://github.com/sponsors/sign 2 | # TODO add: `custom: ["custom-donation-link"]` 3 | -------------------------------------------------------------------------------- /documents/incorporation_certificate.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sign/.github/main/documents/incorporation_certificate.pdf -------------------------------------------------------------------------------- /.prettierrc.json: -------------------------------------------------------------------------------- 1 | { 2 | "trailingComma": "es5", 3 | "singleQuote": true, 4 | "printWidth": 140, 5 | "bracketSameLine": true 6 | } 7 | -------------------------------------------------------------------------------- /profile/README.md: -------------------------------------------------------------------------------- 1 | # [sign.mt](https://sign.mt/) 2 | 3 | Our mission is advancing sign language technology, 4 | bringing language inclusion for all. 5 | -------------------------------------------------------------------------------- /SUPPORT.md: -------------------------------------------------------------------------------- 1 | # Support 2 | 3 | For any public support inquiries, please open an issue. We would love to help! 4 | 5 | For private support inquiries, you can email us at [support@sign.mt](mailto:support@sign.mt). 6 | -------------------------------------------------------------------------------- /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | # These owners will be the default owners for everything in 2 | # the repo. Unless a later match takes precedence, they will 3 | # be requested for review when someone opens a pull request. 4 | * @creativecommons/internal-tech 5 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: true 2 | contact_links: 3 | - name: 💬 Email Us 4 | url: mailto:support@sign.mt 5 | about: Use only in case of a sensitive issue. If it may as well be public, it might be ignored. 6 | -------------------------------------------------------------------------------- /documents/README.md: -------------------------------------------------------------------------------- 1 | # Official Documents 2 | 3 | The company was [incorporated](incorporation_certificate.pdf) in Israel on January 19th, 2022. 4 | 5 | - Company ID: 516541570 6 | - English Name: `SIGN.MT LTD` 7 | - Hebrew Name: `סיין.מט בע״מ` 8 | -------------------------------------------------------------------------------- /tools/_packages.js: -------------------------------------------------------------------------------- 1 | const path = require('path'); 2 | const fs = require('fs'); 3 | 4 | const parentDir = path.join(__dirname, '../', '../'); 5 | 6 | module.exports = function* () { 7 | for (const match of fs.readdirSync(parentDir)) { 8 | if (match === '.DS_Store') { 9 | continue; 10 | } 11 | 12 | const fullPath = path.join(parentDir, match); 13 | if (!fs.lstatSync(fullPath).isDirectory()) { 14 | continue; 15 | } 16 | 17 | if (!fs.existsSync(path.join(fullPath, 'package.json'))) { 18 | continue; 19 | } 20 | 21 | let packageJson; 22 | try { 23 | packageJson = JSON.parse(String(fs.readFileSync(path.join(fullPath, 'package.json')))); 24 | } catch (e) { 25 | console.error(match, 'is missing package.json'); 26 | console.error(e); 27 | } 28 | 29 | if (!packageJson.title) { 30 | continue; 31 | } 32 | 33 | yield [fullPath, packageJson]; 34 | } 35 | }; 36 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "@sign/configuration", 3 | "version": "0.0.1", 4 | "title": ".github", 5 | "icon": { 6 | "emoji": "⚙️" 7 | }, 8 | "description": "Default templates and guidelines for `sign` repositories on GitHub.", 9 | "scripts": { 10 | "lint": "npx prettier --check .", 11 | "prepare": "husky install" 12 | }, 13 | "repository": { 14 | "type": "git", 15 | "url": "git+https://github.com/sign/.github.git" 16 | }, 17 | "author": "Amit Moryossef", 18 | "license": "GPLv3", 19 | "bugs": { 20 | "url": "https://github.com/sign/.github/issues" 21 | }, 22 | "homepage": "https://github.com/sign/.github#readme", 23 | "devDependencies": { 24 | "@material-icons/svg": "^1.0.24", 25 | "cordova-res": "^0.15.4", 26 | "husky": "^7.0.4", 27 | "lint-staged": "^12.1.7", 28 | "prettier": "^2.5.1", 29 | "pwa-asset-generator": "^6.0.6" 30 | }, 31 | "lint-staged": { 32 | "**/*": "prettier --write --ignore-unknown" 33 | } 34 | } 35 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.yml: -------------------------------------------------------------------------------- 1 | name: 💡 Feature Request 2 | description: Suggest a new feature or improvements to an existing one 3 | labels: [enhancement] 4 | title: '[Feature] ' 5 | body: 6 | - type: textarea 7 | attributes: 8 | label: Problem 9 | description: Describe a problem solved by this feature. 10 | validations: 11 | required: false 12 | - type: textarea 13 | attributes: 14 | label: Description 15 | description: Describe the feature and how it solves the problem. 16 | validations: 17 | required: false 18 | - type: textarea 19 | attributes: 20 | label: Alternatives 21 | description: Describe any alternative solutions or features you have considered. How is this feature better? 22 | validations: 23 | required: false 24 | - type: textarea 25 | attributes: 26 | label: Additional context 27 | description: Add any other context about the feature here. 28 | validations: 29 | required: false 30 | -------------------------------------------------------------------------------- /tools/readme.js: -------------------------------------------------------------------------------- 1 | /*** This file generates the README header file for all `sign` repositories ***/ 2 | const path = require('path'); 3 | const fs = require('fs'); 4 | const iterPackages = require('./_packages'); 5 | 6 | const documentsUrl = 'https://github.com/sign/.github/blob/main/'; 7 | 8 | for (const [packagePath, packageJson] of iterPackages()) { 9 | const readmePath = path.join(packagePath, 'README.md'); 10 | 11 | let readmeMd; 12 | try { 13 | readmeMd = String(fs.readFileSync(readmePath)); 14 | } catch (e) { 15 | console.error(match, 'is missing README.md'); 16 | console.error(e); 17 | } 18 | 19 | if (!packageJson.title) { 20 | continue; 21 | } 22 | 23 | const readmeBody = readmeMd.slice(readmeMd.indexOf('---') - 1); 24 | const title = `${packageJson.icon?.emoji}️ \`sign\`/${packageJson.title}`; 25 | const readmeHead = `# ${title} 26 | 27 | ${packageJson.description} 28 | 29 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](${documentsUrl}LICENSE) 30 | [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](${documentsUrl}CODE_OF_CONDUCT.md) 31 | [![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](${documentsUrl}CONTRIBUTING.md)`; 32 | 33 | console.log(title); 34 | fs.writeFileSync(readmePath, readmeHead + '\n' + readmeBody); 35 | } 36 | -------------------------------------------------------------------------------- /BRANDING.md: -------------------------------------------------------------------------------- 1 | # Branding 2 | 3 | The name `sign.mt` was chosen for the ultimate goal of `sign` language `m`achine `t`ranslation. 4 | 5 | For all public, non-legal documents the company is referred to as `sign`. 6 | 7 | ## Domains 8 | 9 | - `sign.mt` 10 | 11 | ## Social Media 12 | 13 | Social IDs should be as close as possible to `sign` or `sign.mt` 14 | 15 | | Platform | Name | Id | 16 | | ---------------------------------------------------- | ------- | ------------- | 17 | | [GitHub](https://www.github.com/sign) | sign | `sign` | 18 | | [Huggingface](https://huggingface.co/sign) | sign.mt | `sign` | 19 | | [Facebook](https://www.facebook.com/sign.mt.ltd) | sign.mt | `sign.mt.ltd` | 20 | | [Twitter](https://twitter.com/signmt_) | sign.mt | `signmt_` | 21 | | [LinkedIn](https://www.linkedin.com/company/sign-mt) | sign.mt | `sign-mt` | 22 | | TikTok | | | 23 | | Instagram | | | 24 | 25 | ## Product names 26 | 27 | All of `sign`'s products should follow a predictable pattern. 28 | 29 | Given a product titled `Product`, it should have the following: 30 | 31 | - **Main Color:** A single main color to distinguish it from other products 32 | - **Logo:** `[icon]` sign Product 33 | - **Repository:** `sign`/Product 34 | - **App Icon:** The selected `[icon]` in solid color, over a white background 35 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # ⚙️️ `sign`/.github 2 | 3 | Default templates and guidelines for `sign` repositories on GitHub. 4 | 5 | [![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://github.com/sign/.github/blob/main/LICENSE) 6 | [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/sign/.github/blob/main/CODE_OF_CONDUCT.md) 7 | [![Contributions Welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/sign/.github/blob/main/CONTRIBUTING.md) 8 | 9 | --- 10 | 11 | ## Overview 12 | 13 | This repository contains general defaults for: 14 | 15 | ### `sign` Policies 16 | 17 | - License: [`LICENSE`](LICENSE) 18 | - Code of Conduct: [`CODE_OF_CONDUCT.md`](CODE_OF_CONDUCT.md) 19 | - Contributing Guidelines: [`CONTRIBUTING.md`](CONTRIBUTING.md) 20 | - Support Guidelines: [`SUPPORT.md`](SUPPORT.md) 21 | - Funding: [`.github/FUNDING.yml`](.github/FUNDING.yml) 22 | - Documents: [`documents/README.md`](documents/README.md) 23 | - Branding: [`BRANDING.md`](BRANDING.md) 24 | 25 | --- 26 | 27 | ### `sign` Templates 28 | 29 | - Issues - 30 | - Helpful Links: [`.github/ISSUE_TEMPLATE/config.yml`](.github/ISSUE_TEMPLATE/config.yml) 31 | - Bug Report: [`.github/ISSUE_TEMPLATE/bug_report.yml`](.github/ISSUE_TEMPLATE/bug_report.yml) 32 | - Feature Request: [`.github/ISSUE_TEMPLATE/feature_request.yml`](.github/ISSUE_TEMPLATE/feature_request.yml) 33 | - Pull Requests: [`.github/PULL_REQUEST_TEMPLATE.md`](.github/PULL_REQUEST_TEMPLATE.md) 34 | 35 | --- 36 | 37 | ### `sign` CI 38 | 39 | - Default GitHub Actions Workflow: [`.github/workflows/main.yml`](.github/workflows/main.yml) 40 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Report a bug 2 | description: File a bug/issue 3 | labels: [bug] 4 | title: '[BUG] ' 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | This issue tracker is for problems with `sign` software. 10 | 11 | To help us understand the issue, please fill-in as much of the following information as you can: 12 | - type: textarea 13 | attributes: 14 | label: Current Behavior 15 | description: A clear & concise description of what you're experiencing. 16 | validations: 17 | required: false 18 | - type: textarea 19 | attributes: 20 | label: Expected Behavior 21 | description: A clear & concise description of what you expected to happen. 22 | validations: 23 | required: false 24 | - type: textarea 25 | attributes: 26 | label: Steps To Reproduce 27 | description: Steps to reproduce the behavior. 28 | validations: 29 | required: false 30 | - type: textarea 31 | attributes: 32 | label: Example flow 33 | description: If you have a minimal example flow that demonstrates the issue, share it here. 34 | value: | 35 | ``` 36 | paste your flow here 37 | ``` 38 | validations: 39 | required: false 40 | - type: textarea 41 | attributes: 42 | label: Environment 43 | description: Please tell us about your environment. Include any relevant information on how you are running our repository. 44 | value: | 45 | - Device: (_eg._ iPhone Xs; laptop) 46 | - OS: (_eg._ iOS 13.5; Fedora 32) 47 | - Browser: (_eg._ Safari; Firefox) 48 | - Version: (_eg._ 13; 73) 49 | - Other info: (_eg._ display resolution, ease-of-access settings) 50 | validations: 51 | required: false 52 | - type: textarea 53 | attributes: 54 | label: Additional context 55 | description: Add any other context about the problem here. 56 | validations: 57 | required: false 58 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to `sign` Repositories 2 | 3 | 🙏 We would ❤️ for you to contribute to `sign` repositories and help make it even better than it is today! 4 | 5 | ## Developing 6 | 7 | Start by installing all dependencies: 8 | 9 | ```bash 10 | npm i 11 | ``` 12 | 13 | Run the tests: 14 | 15 | ```bash 16 | npm test 17 | npm run e2e 18 | ``` 19 | 20 | Run the app: 21 | 22 | ```bash 23 | npm start 24 | ``` 25 | 26 | ## Building 27 | 28 | ```bash 29 | npm run build 30 | ``` 31 | 32 | ## Coding Rules 33 | 34 | To ensure consistency throughout the source code, keep these rules in mind as you are working: 35 | 36 | - All features or bug fixes **must be tested** by one or more specs (unit-tests). 37 | - All public API methods **must be documented**. 38 | 39 | ## Commit Message Guidelines 40 | 41 | We have very precise rules over how our git commit messages can be formatted. This leads to **more 42 | readable messages** that are easy to follow when looking through the **project history**. But also, 43 | we use the git commit messages to **generate the Toaster changelog**. 44 | 45 | ### Commit Message Format 46 | 47 | Each commit message consists of a **header**, a **body** and a **footer**. The header has a special 48 | format that includes a **type**, a **scope** and a **subject**: 49 | 50 | ``` 51 | (): 52 | 53 | 54 | 55 |