https://github.com/philschatz/atom-pull-requests

:octocat: View/Edit comments on a Pull Request directly inside the Atom Editor
https://github.com/philschatz/atom-pull-requests

atom atom-editor pull-requests

Last synced: 3 months ago
JSON representation

:octocat: View/Edit comments on a Pull Request directly inside the Atom Editor

• Host: GitHub
• URL: https://github.com/philschatz/atom-pull-requests
• Owner: philschatz
• Created: 2015-11-18T07:28:34.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-04-12T06:45:29.000Z (about 7 years ago)
• Last Synced: 2025-03-18T04:12:37.705Z (3 months ago)
• Topics: atom, atom-editor, pull-requests
• Language: CoffeeScript
• Homepage:
• Size: 54.7 KB
• Stars: 47
• Watchers: 2
• Forks: 9
• Open Issues: 13
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# pull-requests package for Atom [![gh-board](https://img.shields.io/github/issues/philschatz/atom-pull-requests.svg?label=Issues%20%28gh-board%29)](http://philschatz.com/gh-board/#/r/philschatz:atom-pull-requests)

View/Edit comments on a Pull Request directly inside the Atom Editor.

![atom-pull-requests](https://user-images.githubusercontent.com/253202/33790895-8271c5e2-dc52-11e7-9e65-3f9480678389.gif)

Annoyed when someone litters your elegant code with _"comments"_, and _"suggestions"_? and then you have to sift through all the files in your text editor to find the right place? Fear no more!

# Setup

GitHub restricts talking to their API. You can view public repositories without having to authenticate against GitHub but will be limited to _60 requests per hour_.

If you want to look at **private repositories** or are requesting more than 60 times per hour, you can create a token at https://github.com/settings/tokens and set that in the plugin config.

- Just leave all the scopes checkboxes _unchecked_ to give this plugin the minimal permissions necessary.

# TODO

- [x] work with private or enterprise repositories (see package settings)

- [x] show comment counts in tree view and in file tab

- [x] render all MarkDown in the comments

  - [ ] render emojis

- [ ] support forked Pull Requests

- [ ] do local diff of all commits since the one pushed to GitHub

  - [ ] let user know that they have unpushed commits

- [ ] support comments made to the entire Pull Request (not just lines in the code)

# Atom API Suggestions

- expose a `tree-view` file decorator that can add classes asynchronously

  - see [atom/tree-view#658](https://github.com/atom/tree-view/pull/658) for progress on this feature

- expose a `tabs` filename decorator so open tabs can have the # of comments in the file

# `atom-community/linter` suggestions

- provide icons in gutter markers

# Config

For private repositories you need to create a token @ github:

 1. Go to https://github.com/settings/tokens and create a new token

 2. Open your config.cson

 3. Add this snippet (replacing '*my-git-token*' with the token you created

```cson  

  "pull-requests":

    githubAuthorizationToken: "my-git-token"

```