Skip to content

Commit d567963

Browse files
committed
Update CONTRIBUTING.md
1 parent 3f4a0ab commit d567963

File tree

1 file changed

+19
-9
lines changed

1 file changed

+19
-9
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,16 @@ guide](https://github.com/atom/atom/blob/master/CONTRIBUTING.md)
2828

2929
Is rather simple. Here are some steps to get you running:
3030

31+
Hack on it using your favorite TypeScript package. There are a couple packages in Atom to select from:
32+
https://atom.io/packages/atom-typescript
33+
https://atom.io/packages/ide-typescript
34+
Prettify the code by running npm run prettier
35+
Run static checks with npm test (this will run typecheck and linter, and check if formatting is OK)
36+
Run dynamic test-suite with apm test
37+
Commit your changes. Repeat steps 4-8 until satisfied.
38+
Transpile to JavaScript & bundle by running npm run build and commit transpiled source in dist/ and client/.
39+
Create a pull request.
40+
3141
1. Fork the repository (the button in top right corner of GitHub page)
3242

3343
2. Clone your fork
@@ -54,8 +64,9 @@ Is rather simple. Here are some steps to get you running:
5464

5565
Install development dependencies with `npm install --only=dev`.
5666

57-
Optionally `apm link` if you want to test your changes in Atom. Be
58-
careful if you're using `atom-typescript` to hack on
67+
Run `apm link --dev` to enable your fork in Atom's dev-mode. To check your changes, run Atom in dev-mode (start with `atom --dev` or run `application:open-dev` from command palette).
68+
69+
Be careful if you're using `atom-typescript` to hack on
5970
`atom-typescript` though! You'd be hacking on the software using the
6071
same software you're currently hacking on, which sounds somewhat
6172
convoluted because it is. See [section on workflow](#workflow) below
@@ -65,17 +76,16 @@ Is rather simple. Here are some steps to get you running:
6576

6677
6. Prettify the code by running `npm run prettier`
6778

68-
7. Transpile to JavaScript by running `npm run build`
69-
70-
8. Run static checks with `npm run test` (this will run typechecker and
79+
7. Run static checks with `npm run test` (this will run typechecker and
7180
linter, and check if formatting is OK)
7281

73-
9. Run dynamic test-suite with `apm test` (at the moment, it's rather
82+
8. Run dynamic test-suite with `apm test` (at the moment, it's rather
7483
anemic and only checks if package loads at all)
7584

76-
10. Commit your changes. Don't forget to commit transpiled source in
77-
`dist/`. Write a meaningful description for your commit! Push often!
78-
Repeat steps 4-9 until satisfied.
85+
9. Commit your changes. Write a meaningful description for your commit!
86+
Push often! Repeat steps 5-9 until satisfied.
87+
88+
10. Transpile to JavaScript & bundle by running `npm run build` and commit transpiled source in `dist/`.
7989

8090
11. Create a pull request.
8191

0 commit comments

Comments
 (0)