-
Notifications
You must be signed in to change notification settings - Fork 144
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
From Xi-Editor and slightly modified for mac only use
- Loading branch information
1 parent
755fdd5
commit c0d666a
Showing
2 changed files
with
61 additions
and
0 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,19 @@ | ||
| # Xi-Mac Issue Template | ||
| - [ ] I have searched existing issues and could not find my issue. | ||
| - [ ] I have studied the documentation. | ||
|
|
||
| <!--- | ||
| Please ensure the issue meets these requirements. If you are not sure, questions | ||
| are welcome on the #xi-mac channel on https://xi.zulipchat.com. | ||
| ---> | ||
| ## Details | ||
|
|
||
| _If your issue is a build or runtime error, please include the following:_ | ||
| - macOS version (e.g. macOS 10.13.2) | ||
| - the commit you're on, if building from source (`#3a2405b`) | ||
| - a full backtrace or error message, if available | ||
|
|
||
| ## Expected vs Actual | ||
| When describing an issue, it is very helpful to first describe expected behavior, followed by the actual functionality. See the following example: | ||
|
|
||
| _Note that backticks can be used to escape code both inline and in blocks._ |
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,42 @@ | ||
| <!--- | ||
| Welcome to the xi-mac front end of the xi-editor project! We're very excited for your contribution to become a part of the editor. | ||
| This template provides some basic instructions on how to format a pull request, so we can more easily understand it. | ||
| Anything within this commented block will not be a part of the visible text. | ||
| The first part of your pull request should be a summary describing its intent. This is also an appropriate place to explain the motivation behind the changes it introduces. | ||
| ---> | ||
| ## Summary | ||
| Example: `Add a pull request template. This will make it easier for newcomers to contribute to the project with confidence.` | ||
|
|
||
|
|
||
|
|
||
| <!--- | ||
| Give reviewers and interested parties a good idea of how this is related to other issues or pull requests. | ||
| ---> | ||
| ## Related Issues | ||
| Example: `Related to #1` | ||
|
|
||
| <!--- | ||
| GitHub has built-in functionality for closing issues when PR's are merged. TLDR: `closes #1` closes issue number 1 when the PR merges. | ||
| See [closing issues using keywords](https://help.github.com/articles/closing-issues-using-keywords/) for more info. | ||
| ---> | ||
| Example: `closes #2` | ||
|
|
||
| <!--- | ||
| Checklists are a useful tool for tracking your progress with longer pull requests. It gives reviewers a clear idea of how far you've come, and what can be reviewed. It's also fun to check off those boxes! | ||
| ---> | ||
| ## Checklist | ||
| Example: | ||
|
|
||
| - [ ] Example check-list item | ||
| - [x] Create a pull request template | ||
| - [ ] make xi perfect | ||
|
|
||
| ## Review Checklist | ||
| <!--- | ||
| Here is a list of the things everyone should make sure they do before they want their PR to be merged. | ||
| ---> | ||
| - [ ] I have responded to reviews and made changes where appropriate. | ||
| - [ ] I have tested the code | ||
| - [ ] I have updated comments / documentation related to the changes I made. | ||
| - [ ] I have rebased my PR branch onto xi-mac/master. |