github/semantic
1
1
Fork 0
mirror of https://github.com/github/semantic.git synced 2024-12-19 12:51:52 +03:00
Code Issues Projects Releases Wiki Activity

Merge pull request #621 from github/semantic-codemap

Browse Source 
Roadmap updates, mid-year edition
This commit is contained in:
Rob Rix 2016-07-05 10:55:07 -04:00 committed by GitHub
commit 0090b0955f
1 changed files with 39 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
ROADMAP.md
View File

@ -1,17 +1,47 @@
# Semantic diff roadmap
# Roadmap
## Q1 2016
## Things we are currently doing:
1. [Staff ship & limited beta of semantic diffing on .com](https://github.com/github/semantic-diff/milestones/Staff%20Ship). This will be an opt-in, limited release of semantic diffs for a very small set of languages. UI in general will be unchanged; we’ll simply start showing better diffs for the languages in question. The goal is to ease ourselves into deployment of the system, and benchmark under real loads.
1. [Diff summaries][] for C & JavaScript. Q3 2016 or so.
2. [Semantic diffing on .com](https://github.com/github/semantic-diff/milestones/Dot%20Calm). General release of semantic diffs for the supported languages.
- Modelling the abstract semantics of the supported languages. Good summaries require us to know what different parts of the syntax represent.
- Performance/responsiveness. We need to be able to produce diffs more quickly, and without unicorns. Some of this will involve front-end work (e.g. requesting summaries out-of-band).
2. [Semantic diffs][] on .com for C & JavaScript. Q4 2016 or so.
## Q2–Q4 2016
- Performance, as above.
- Resilience. A fault in `semantic-git-diff` should not break anything else.
- Metrics. We need to know how it’s behaving in the wild to know what to do about it. This also includes operational metrics such as health checks.
We will discuss future milestones at the **@github/network-intelligence** minisummit mid-Q1 2016, and document them here at that point.
## Follow-up things:
## Ongoing
1. Add support for more languages: [Ruby][], etc.
2. [Detecting & rendering moves][moves].
3. [Merging][].
4. Refining the diff summaries we produce.
- Creation, curation, and cultivation of grammars for semantic diffs.
## Things we would like to do:
1. [Interactively refining diffs][interactive].
2. [Filtering][] diffs.
3. Diff [table of contents][].
4. [Jump to symbol definition][].
5. Eliminate conflicts from renaming [variables][].
## Things we would like to do modulo interest/support from other teams:
1. APIs/tooling for data science & engineering teams.
2. Collect data on our heuristics &c. and refine them via e.g. ML.
3. Diffs as a [service][].
[Diff summaries]: https://github.com/github/semantic-diff/milestones/Summer%20Eyes
[Semantic diffs]: https://github.com/github/semantic-diff/milestones/Dot%20Calm
[Ruby]: https://github.com/github/semantic-diff/issues/282
[moves]: https://github.com/github/semantic-diff/issues/389
[Merging]: https://github.com/github/semantic-diff/issues/431
[interactive]: https://github.com/github/semantic-diff/issues/130
[Filtering]: https://github.com/github/semantic-diff/issues/428
[table of contents]: https://github.com/github/semantic-diff/issues/16
[Jump to symbol definition]: https://github.com/github/semantic-diff/issues/6
[variables]: https://github.com/github/semantic-diff/issues/91
[service]: https://github.com/github/platform/blob/master/services/README.md