Skip to content
This repository has been archived by the owner on Jan 1, 2023. It is now read-only.

Developer Documentation? -> Creating new features #128

Open
alejandrojapkin opened this issue Mar 6, 2019 · 2 comments
Open

Developer Documentation? -> Creating new features #128

alejandrojapkin opened this issue Mar 6, 2019 · 2 comments

Comments

@alejandrojapkin
Copy link

I'm looking to rescope the featureset in a fork which you may eventually merge. Your code is big, somewhat cumbersome:

  1. How do I implement a new tab / view in the main window which talks to the repo information but introduces other libraries and visualization concepts?
  2. I'm working on PyCharm, do you recommend vscode for code structure?
  3. I'm a Python dev struggling with your Angular code. I see much protractor and jasmine, are there any templates of code you suggest reusing to implement new views?
@Yamazaki93
Copy link
Owner

Hi @datascienceteam01,

Thanks for the feedback and I am excited to see you decided to participate. Yes I do realize that the code is complex. It was more of a pet project starting out and it just grows.

  1. Regarding a new tabs, I am assuming you meant the right panel, I'll compile some detailed documentation later. But here's an overview that can hopefully get you started:
  • /app/frontend/src/app/core/commit-detail/ is the master component of the side panel which has both the tabs (in .commit-detail-nav-container) and contents of the tabs (in .commit-detail-content)
  • Take the first tab for example, the details of the selected commit, app/frontend/src/app/core/commit-detail-info/ and all the contents inside .commit-detail-info-container is displayed in the tabs.
  1. I use vscode myself

  2. For the case of new tabs on the right panel, app/frontend/src/app/core/commit-detail-info/ component would be an example of that.

Hope these helps,

@alejandrojapkin
Copy link
Author

  1. I haven't been able to build the code yet. Issues on Mac (the yarn install demands XCode installed and the build.sh returns "At least electron-updater 4.0.0 is recommended by current electron-builder version. Please set electron-updater version to "^4.0.0" ) . Please advice if you prefer a separate ticket for this.
  2. Perhaps because I couldn't properly run the code it's still unclear what instantiates a tab. I need to make the default screen a different screen and then add two additional tabs. I see that your views are TypeScript files with a sidecar HTML and I'm assuming this is built in an MVP pattern. Please expand if you can here.
  3. The code seems to have some vscode artifacts so I'm wondering if I'd have an easier time building it/testing it from vscode.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants