2016-06-15 14:29:35 +00:00
|
|
|
# GitHub Desktop Documentation
|
|
|
|
|
|
2017-05-04 11:56:57 +00:00
|
|
|
This is the [GitHub Desktop](https://github.com/desktop/desktop) development
|
|
|
|
|
documentation.
|
2016-06-15 14:29:35 +00:00
|
|
|
|
2017-04-18 12:32:33 +00:00
|
|
|
## Contributing
|
|
|
|
|
|
2017-05-04 11:56:57 +00:00
|
|
|
If you are interested in contributing to the project, you should read these
|
|
|
|
|
resources to get familiar with how things work:
|
2017-04-18 12:32:33 +00:00
|
|
|
|
2018-02-26 15:24:58 +00:00
|
|
|
- **[How Can I Contribute?](../.github/CONTRIBUTING.md#how-can-i-contribute)** -
|
2018-02-01 23:08:53 +00:00
|
|
|
details about how you can participate
|
|
|
|
|
- **[Development Environment Setup](contributing/setup.md)** - everything
|
|
|
|
|
you need to know to get Desktop up and running
|
|
|
|
|
- **[Engineering Values](contributing/engineering-values.md)** - our high-level engineering values
|
|
|
|
|
- **[Style Guide](contributing/styleguide.md)** - notes on the coding style
|
|
|
|
|
- **[Tooling](contributing/tooling.md)** - if you have a preferred IDE,
|
|
|
|
|
there's some enhancements to make your life easier
|
|
|
|
|
- **[Troubleshooting](contributing/troubleshooting.md)** - some additional
|
|
|
|
|
known issues if you're having environment issues
|
2017-04-18 12:32:33 +00:00
|
|
|
|
|
|
|
|
## Process
|
|
|
|
|
|
2017-05-04 03:12:42 +00:00
|
|
|
Details about how the team is organizing and shipping GitHub Desktop:
|
2017-04-18 12:32:33 +00:00
|
|
|
|
2018-02-01 23:08:53 +00:00
|
|
|
- **[Roadmap](process/roadmap.md)** - the future as planned so far
|
|
|
|
|
- **[Release Planning](process/release-planning.md)** - how we plan and execute
|
|
|
|
|
releases
|
|
|
|
|
- **[Issue Triage](process/issue-triage.md)** - how we address issues reported
|
|
|
|
|
by users
|
2019-09-06 15:50:35 +00:00
|
|
|
- **[Pull Requests](process/pull-requests.md)** - how code contributions are submitted and reviewed
|
2018-02-01 23:08:53 +00:00
|
|
|
- **[Releasing Updates](process/releasing-updates.md)** - how we deploy things
|
2017-04-18 12:32:33 +00:00
|
|
|
|
|
|
|
|
## Technical
|
|
|
|
|
|
2018-02-01 23:08:53 +00:00
|
|
|
These documents contain more details about the internals of GitHub Desktop
|
|
|
|
|
and how things work:
|
2017-04-18 12:32:33 +00:00
|
|
|
|
2018-02-01 23:08:53 +00:00
|
|
|
- **[Dialogs](technical/dialogs.md)** - details about the dialog component API
|
|
|
|
|
- **[Windows menu bar](technical/windows-menu-bar.md)** - Electron doesn't
|
|
|
|
|
provide inbuilt support for styling the menu for Windows, so we've created
|
|
|
|
|
our own custom components to achieve this.
|
|
|
|
|
- **[Developer OAuth App](technical/oauth.md)** - GitHub Desktop ships with
|
|
|
|
|
the ability to OAuth on behalf of a user. A developer OAuth app is bundled
|
|
|
|
|
to reduce the friction of getting started.
|
2018-09-21 20:26:32 +00:00
|
|
|
- **[Building and Packaging Desktop](technical/packaging.md)** - Outlines how
|
|
|
|
|
Desktop is currently packaged for all platforms
|
2020-03-12 16:21:04 +00:00
|
|
|
- **[Automatic Git Proxy support](technical/proxies.md)** - A pre-launch overview
|
|
|
|
|
and troubleshooting guide for the Git automatic proxy support in GitHub Desktop.
|
