-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Renames `person.tsp` to `people.tsp` because SWAPI uses the plural name in most documentation. Includes this in the new CONTRIBUTING documentation. Moves some existing developing documentation from README into the new documentation.
- Loading branch information
Showing
4 changed files
with
21 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# Contributing | ||
|
||
## Developing | ||
|
||
### Run scripts | ||
|
||
Use `npm run` to list all available scripts. The `release` script executes a | ||
“release build.” The CI build uses this script. | ||
|
||
### Directory structure | ||
|
||
- [src](./src) contains the TypeSpec (`.tsp`) files | ||
|
||
## TypeSpec conventions | ||
|
||
- Separate files by type. Name files using the plural form, which SWAPI uses | ||
in its documentation. | ||
|
||
- Using `@resource` adds _all_ REST operations. Thus, the spec files explicitly | ||
configure `list` and `read` operations because SWAPI only supports those. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,2 @@ | ||
import "./root.tsp"; | ||
import "./person.tsp"; | ||
import "./people.tsp"; |
File renamed without changes.