|
| 1 | +# How to contribute |
| 2 | + |
| 3 | +Thank you for contributing to the Typeform Embed software development kit (SDK)! We're glad you're here and grateful for your help. |
| 4 | + |
| 5 | +This document describes how to set up the project locally, our development goals, and how to submit your changes in pull requests and send us your ideas and feedback. |
| 6 | + |
| 7 | +## Local set up |
| 8 | + |
| 9 | +Requirements: |
| 10 | +* `node` >= 12 |
| 11 | +* `yarn` |
| 12 | +* `java` >= 14 (to run visual tests) |
| 13 | + |
| 14 | +To work with Embed as a developer: |
| 15 | + |
| 16 | +1. [fork](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) this repository (https://github.com/Typeform/embed) |
| 17 | +2. clone your fork: |
| 18 | + ```bash |
| 19 | + $ git clone git@github.com:<your-github-username>/embed.git |
| 20 | + $ cd embed |
| 21 | + ``` |
| 22 | +3. install dependencies |
| 23 | + ```bash |
| 24 | + $ yarn |
| 25 | + ``` |
| 26 | +4. run: |
| 27 | + ```bash |
| 28 | + $ yarn start # start mock-server and run in development the renderer |
| 29 | + $ yarn test # run lint, unit and functional tests |
| 30 | + $ yarn test:visual # run visual tests (requires EYES_API_KEY env var for AppliTools) |
| 31 | + $ yarn build # build project to ./dist and ./lib |
| 32 | + $ yarn clean # delete directories with built files (./dist and ./lib) |
| 33 | + ``` |
| 34 | + |
| 35 | +## Development goals |
| 36 | + |
| 37 | +<!-- * TODO: add items to this bullet list of your current goals for Embed --> |
| 38 | +<!-- * TODO: add any priorities you want readers to know about --> |
| 39 | + |
| 40 | +## Development suggestions |
| 41 | + |
| 42 | +<!-- TODO: add any "wishlist" items you hope someone might develop --> |
| 43 | + |
| 44 | +We're always looking for new ways to embed the typeform, code samples and more. |
| 45 | +
|
| 46 | +If you have an idea for a community project, please [tell us about it](https://collect.typeform.com/to/F9jz78)! |
| 47 | +
|
| 48 | +## Submit your changes via pull request |
| 49 | +
|
| 50 | +Submit your changes via [GitHub pull request](https://help.github.com/articles/about-pull-requests/) to [/Typeform/embed](https://github.com/Typeform/embed/pulls) with a clear list of the changes you're making. Only one feature per commit. |
| 51 | + |
| 52 | +Commit messages should follow the [angular project guidelines](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#commits). In short, your message needs to include: |
| 53 | +* type (feat, fix, docs, style, refactor, perf, test, chore, revert) |
| 54 | +* scope - uppercase JIRA ticket number goes here, you can leave it empty |
| 55 | +* message |
| 56 | +* body (optional) |
| 57 | +* footer (for breaking change only) |
| 58 | + |
| 59 | +Commit message example: |
| 60 | +``` |
| 61 | +type(scope): Commit headline |
| 62 | + |
| 63 | +Body of your commit message is optional. Explain your changes in detail here. |
| 64 | +Can have multiple lines. |
| 65 | + |
| 66 | +BREAKING CHANGE: This line should explain which changes. It is required onyl for commits with breaking change. |
| 67 | +``` |
| 68 | +
|
| 69 | +Each open pull request will be tested automatically with: |
| 70 | +```bash |
| 71 | +$ yarn test |
| 72 | +$ yarn test:visual |
| 73 | +``` |
| 74 | + |
| 75 | +## Send us feedback |
| 76 | + |
| 77 | +[Send us feedback about the Embed SDK](https://collect.typeform.com/to/F9jz78). We can't wait to hear what you think! |
0 commit comments