Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mcomella/apt_github_improvements
A browser extension to add features to GitHub for the Android Product Team (APT) at Mozilla
https://github.com/mcomella/apt_github_improvements
github mozilla mozilla-mobile
Last synced: 12 days ago
JSON representation
A browser extension to add features to GitHub for the Android Product Team (APT) at Mozilla
- Host: GitHub
- URL: https://github.com/mcomella/apt_github_improvements
- Owner: mcomella
- License: mpl-2.0
- Created: 2018-07-14T20:44:31.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-07-11T02:02:28.000Z (over 5 years ago)
- Last Synced: 2024-11-13T12:29:34.415Z (2 months ago)
- Topics: github, mozilla, mozilla-mobile
- Language: TypeScript
- Homepage:
- Size: 747 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# APT GitHub Improvements
The Android Product Team (APT) at Mozilla uses GitHub to develop their products and faces challenges with GitHub, both due to GitHub's existing functionality and the specifics of the APT workflow. APT GitHub Improvements is a browser extension that adds to the GitHub interface in order to address these problems.
[Available on addons.mozilla.org][AMO]
### Features
For an overview of how we decide which features make it into the project, see [Feature Philosophy].
Features for general GitHub users:
- [Link Issues to Pull Requests](docs/features/link_issues_to_prs.md)
- [Link Issue Numbers in Pull Request titles](docs/features/link_issues_in_pr_titles.md)
- [Indicate PRs that address issues in issues list](docs/features/indicate_prs_to_issues_list.md)
Features for APT/Mozilla specifically (these will generally not appear when the user is not on APT/Mozilla repositories):
- [Story Points](docs/features/story_points.md)
- [Hoist Bugzilla bug links to the top of the issue](docs/features/hoist_bugzilla_bugs_to_top_of_issue.md)
- [Link Bugzilla "Bug 123" in comments](docs/features/link_bugzilla_bug_123.md)
### Usage
Some features access the GitHub API: it is [**highly recommended** to add a GitHub access token](docs/add_an_access_token.md) to avoid restricting them.
For an explanation of **required permissions**, see [permissions.md](docs/permissions.md).
### Project Resources
* Open issues: https://github.com/mcomella/apt_github_improvements/issues
* Documentation: https://github.com/mcomella/apt_github_improvements/tree/master/docs
## Differences from other solutions
This extension adds unique functionality for Mozilla/APT so there are no existing solutions for this functionality. However, when considering this extension's features that address a general GitHub audience, there is some overlap.
[Refined GitHub][rg] is a "browser extension that simplifies the GitHub interface and adds useful features" but has features that contradict APT GitHub Improvement's [Feature Philosophy]. Additionally, Refined GitHub requires you to be logged in and [has many dependencies][rg deps].
There are other solutions that add/change GitHub functionality but they generally address a single user problem that does not overlap in scope with APT GitHub Improvements.
Some individual features in this add-on will include references to other solutions.
## Development
Install global dependencies:
- [nodejs] (8.11.4 LTS)
- npm
Install project dependencies:
```sh
npm install
```
### Running
To build, run either:
```
npm run build
npm run watch # Rebuilds when files change
```
To run the compiled output in Firefox, you can load
[a temporary add-on][temp addon].
Development with Visual Studio Code is recommended, given its awareness of Typescript types.
### Testing
The tests can be found in the `./spec` directory. To run:
```sh
npm test
```
### Publishing
`dist/bundle.xpi` will be created after:
```sh
./scripts/publish.sh
```
## License
```
This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/.
```
[hoister]: https://github.com/mcomella/github-issue-hoister
[typed]: https://github.com/DefinitelyTyped/DefinitelyTyped
[temp addon]: https://developer.mozilla.org/en-US/docs/Tools/about:debugging#Enabling_add-on_debugging
[AMO]: https://addons.mozilla.org/en-US/firefox/addon/apt-github-improvements/
[rg]: https://github.com/sindresorhus/refined-github/
[Feature Philosophy]: docs/feature_philosophy.md
[rg deps]: https://gist.github.com/mcomella/d99838853cffb22347cc34a1b553d6ba
[nodejs]: https://nodejs.org/en/