👍 🎉 💖 Thanks for your interest! 💖 🎉 👍
The following is a set of guidelines for contributing to GitHub Desktop and its related projects, which are hosted in the Desktop Organization on GitHub. These are just guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
Note that GitHub Desktop is currently a public beta, so everything is likely to change over time as we learn and refine how we work with the community.
What should I know before I get started?
This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].
Currently GitHub Desktop is in a public beta, and the team is focused on triaging reported issues and working towards a 1.0 milestone - where the application can be used in place of the classic Mac and Windows applications. You can follow this progress progress under the Milestones tab.
We're still thinking about where we want to take GitHub Desktop after we reach this 1.0 milestone. If you have ideas or suggestions please read the Suggesting Enhancements section below to understand how to contribute your feedback.
This section guides you through submitting a bug report for GitHub Desktop. Following these guidelines helps maintainers and the community understand your report 📝, reproduce the behavior 💻 💻, and find related reports 🔎.
Before creating bug reports, please check this list as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible. Fill out the required template, the information it asks for helps us resolve issues faster.
Perform a cursory search to see if the problem has already been reported. If it does exist, add a :thumbsup: to the issue to indicate this is also an issue for you, and add a comment to the existing issue if there is extra information you can contribute.
Bugs are tracked as GitHub issues.
Simply create an issue on the GitHub Desktop issue tracker and fill out the provided issue template.
The information we are interested in includes:
- details about your environment - which build, which operating system
- details about reproducing the issue - what steps to take, what happens, how often it happens
- other relevant information - log files, screenshots, etc
This section guides you through submitting an enhancement suggestion for GitHub Desktop, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion 📝 and find related suggestions 🔎.
Before creating enhancement suggestions, please check this list as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please include as many details as possible. Fill in the template, including the steps that you imagine you would take if the feature you're requesting existed.
Perform a cursory search to see if the enhancement has already been suggested. If it has, add a :thumbsup: to indicate your interest in it, or comment if there is additional information you would like to add.
Enhancement suggestions are tracked as GitHub issues.
Simply create an issue on the GitHub Desktop issue tracker and provide the following information:
- Use a clear and descriptive title for the issue to identify the suggestion.
- Provide a step-by-step description of the suggested enhancement in as much detail as possible. This additional context helps the maintainers to understand the enhancement from your perspective
- Explain why this enhancement would be useful to GitHub Desktop users.
- Include screenshots and animated GIFs if relevent to help you demonstrate the steps or point out the part of GitHub Desktop which the suggestion is related to. You can use this tool to record GIFs on macOS and Windows.
- List some other applications where this enhancement exists, if applicable.
As the team is working towards the 1.0 release, we'll identify enhancements or bugs that can be categorised as tasks that:
- have low impact, or have a known workaround
- should be fixed
- have a narrow scope and/or easy reproduction steps
- can be worked on independent of other tasks
These issues will be labelled as up-for-grabs
in the repository. If you are interested in contributing to the project, please
comment on the issue to let the maintainers (and community) know you are
interested in picking this up.
This section lists the labels we use to help us track and manage issues and pull requests.
| Label name | 🔎 | Description |
|---|---|---|
enhancement |
search | Feature requests. |
bug |
search | Confirmed bugs or reports that are very likely to be bugs. |
question |
search | Questions more than bug reports or feature requests (e.g. how do I do X). |
more-information-needed |
search | More information needs to be collected about these problems or feature requests (e.g. steps to reproduce). |
needs-reproduction |
search | Likely bugs, but haven't been reliably reproduced. |
macOS |
search | Issues specific to macOS users. |
Windows |
search | Issues specific to Windows users. |
| Label name | 🔎 | Description |
|---|---|---|
up-for-grabs |
search | Issues marked as ideal for external contributors. |
polish |
search | Issues not critical to the application but would provide a better experience if resolved. |
tech-debt |
search | Issues related to code or architecture decisions. |
design |
search | Issues that require some design input from the maintainers as part of completing the work. |
| Label name | 🔎 | Description |
|---|---|---|
ready-for-review |
search | Pull Requests that are ready to be reviewed by the maintainers. |