development/github-desktop
development/github-desktop
1
0
Fork 0
mirror of https://github.com/desktop/desktop synced 2024-11-05 20:49:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

tidy up

Browse source
This commit is contained in:
Brendan Forster 2017-04-21 17:17:04 +10:00
parent f79eb6210d
commit 499b06ddd1
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
docs/contributing/styleguide.md
View file

@ -62,9 +62,13 @@ We do this by making the methods look unappealing:
### Application Code
We should be using asynchronous core APIs throughout the application, unless
there's a compelling reason and no asynchronous alternative. And in those cases
the method should be suffixed with `Sync` to make it clear to the caller what's
happening.
there's a compelling reason and no asynchronous alternative. In those cases the
method should be suffixed with `Sync` to make it clear to the caller what's
happening. We also fall back to `Sync` methods for readability in tests.
For more information about this, we added a `tslint` rule in
[#1249](https://github.com/desktop/desktop/pull/1249) to verify our usage of
synchronous functions across the codebase.
### Scripts

6
docs/process/reviews.md
View file

@ -23,9 +23,9 @@ The rest of this document goes into more details around this flow.
### Work-in-Progress
We recommend open pull requests early - ideally as soon as you have somethign to
show off. This is especially helpful for large changes, as continuous
integration tests are run earlier on, and any regressions can be caught before
We recommend open pull requests early - ideally as soon as you have something to
show. This is especially helpful for large pieces of work, as continuous
integration tests are run earlier on, and regressions can be caught before
humans get involved.
Until the code is ready for review, you can prefix the PR title with [WIP] to