[ALOY-1367] Guide on how to submit a PR to the Alloy repo
| GitHub Issue | n/a |
|---|---|
| Type | Story |
| Priority | Medium |
| Status | Resolved |
| Resolution | Won't Do |
| Resolution Date | 2016-05-02T23:26:15.000+0000 |
| Affected Version/s | n/a |
| Fix Version/s | n/a |
| Components | n/a |
| Labels | notable |
| Reporter | Feon Sua Xin Miao |
| Assignee | Fokke Zandbergen |
| Created | 2016-03-11T19:27:09.000+0000 |
| Updated | 2016-05-02T23:26:15.000+0000 |
Description
We don't have a concise developer guide for Alloy.
It would be great if there is a page that provides step by step guide for anyone who wants to contribute to Alloy.
Some of the basic requirement for a PR to warrant a review:
1. Sign the CLA
2. Link to JIRA ticket
3. Include test app
4. All tests should pass
5. Code Conventions, this would be solved by integrate a linter.
Some scripts that really we should wrap in simple NodeJS script: *How to create a test app*
node tools/create_test.js TICKET*How to run a single test app*jake app:run dir=testing/TICKET*How to generate known good code for a test app*node tools/create_generated_code.js testing/TICKET*How to test a single test app compile*app=testing/TICKET jake test:spec\[compile.js\]*How to test a single test app plus Alloy*app=testing/TICKET jake test:all*How to test all*jake test:all[~fmiao] i think this should go to TIDOCS? [~bimmel] fyi.
[~cng] It sure should, but it needs some more work/thoughts and ideally we'd improve the scripts to simplify. But then, since [~cbarber] is moving Alloy into Titanium this all might be old news soon.
I wouldn't put any energy into this. Instead I would clean up the TiSDK contributor guide, of which there is a ticket for somewhere.