You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Dec 15, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-1Lines changed: 23 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ In particular, the GitHub package is under constant development by a portion of
6
6
7
7
Feel free to [open an issue](https://github.com/atom/github/issues) if you want to discuss anything with us. If you're curious what we're working on and will be working on in the near future, you can take a look at [our short-term roadmap](https://github.com/atom/github/projects/8).
8
8
9
-
## Technical Contribution Tips
9
+
## Technical contribution tips
10
10
11
11
### Updating the GraphQL Schema
12
12
@@ -23,6 +23,7 @@ Please check in the generated `graphql/schema.graphql`.
23
23
In addition, if you make any changes to any of the GraphQL queries or fragments (inside the `graphql` tagged template literals), you will need to run `npm run relay` to regenerate the statically-generated query files.
24
24
25
25
## Testing
26
+
26
27
To run tests, open the command palette and select "Run Package Specs". This will open a new window running "GitHub Package Tests". If the window stays blank for more than a few seconds, open DevTools and check for error messages.
27
28
28
29
To re-run tests, you can refresh that window by pressing `Cmd + R` in DevTools.
This transpiles into a form similar to the one above, so is asynchronous, but if the test fails, we'll still see a message that contains 'expected 0 to equal 1'.
64
65
65
66
When writing tests that depend on values that get set asynchronously, prefer `assert.async.x(...)` over other forms.
67
+
68
+
## Living on the edge
69
+
70
+
If you're working on the GitHub package day-to-day, it's useful to have a development environment configured to use the latest and greatest source.
71
+
72
+
1.[Build Atom from master](https://github.com/atom/atom/tree/master/docs/build-instructions) frequently if you can. This will help us notice any changes in Atom core that cause regressions.
73
+
2. Install the GitHub package from its git URL:
74
+
75
+
```sh
76
+
$ apm install atom/github
77
+
```
78
+
79
+
When you run Atom in non-dev-mode (`atom .`) you'll be running the latest _merged_ code in this repository. If this isn't stable enough for day-to-day work, then we have bugs to fix :wink:
80
+
3. Link your GitHub package source in dev mode:
81
+
82
+
```sh
83
+
# In the root directory of your atom/github clone
84
+
$ apm link --dev .
85
+
```
86
+
87
+
When you run Atom in dev mode (`atom -d .`) you'll be running your local changes. This is useful for reproducing bugs or trying out new changes live before merging them.
0 commit comments