What general coding and style guide to follow?

[franzwil]

Hi,

as there were some ideas shared about what should be a good pull request style in #27, I'd like to open up the discussion on how the html files in this project should be written in general.

My questions:

1. Why do you use a router to 'graph/main' in Initial Graph and OmnaiScope Server Connection #18? Do you want to add more windows and if so which ones?
2. Why did you add an custom-styles.scss in the same request? Isn't this conflicting with the styles given in styles.css?

My suggestions for the styling:

1. Instead of adding "styles" in the as attributes of the elements I would use the respective css file of each component.
2. I would add a starting page component instead of graph/main for clarity because graph is a class on its own.
3. There are style guides for Angular and Typescript. Maybe it would be good to add them to the CONTRIBUTE.md?
4. Concering Angular style, I would suggest the following:
   • I would also get the interfaces for devices and data format to an extra model.
   • I would like to rearrange some services as some don't belong to a specific component. Also I would change some names for clarity.

[AKMaily]

Hello,

1. Why do you use a router to 'graph/main' in Initial Graph and OmnaiScope Server Connection #18? Do you want to add more windows and if so which ones?
   > 2. I would add a starting page component instead of graph/main for clarity because graph is a class on its own.

It is not planned to add more than one window in the application, to keep the application as easy as possible. Therefore i would also suggest to change the name of the route

2. Why did you add an custom-styles.scss in the same request? Isn't this conflicting with the styles given in styles.css?
   > 1. Instead of adding "styles" in the as attributes of the elements I would use the respective css file of each component.

I currently cant answer this question. @tabeatheunicorn could you give further information on this ?

3. There are style guides for Angular and Typescript. Maybe it would be good to add them to the CONTRIBUTE.md?

It seems like a good idea to link them in the CONTRIBUTE.md as a reference.

4. Concering Angular style, I would suggest the following:

   • I would also get the interfaces for devices and data format to an extra model.
   • I would like to rearrange some services as some don't belong to a specific component. Also I would change some names for clarity.

My Suggestion would be to apply the changes you think about and discuss them in the PRs for those changes. Generally it seems like a good idea to make the codebase more structured and readable.

[tabeatheunicorn]

I personally prefer intention over actual style guides (apart from the Angular and TypeScript best practices).

• Code must always show what you want to achieve. If it isn’t obvious, write a comment explaining why you do it.
• Use clear names for everything. Avoid abbreviations unless everybody knows them.
• Don’t use magic values—define constants and name them.
• Every part of the code should have one job. If something does too much or is unclear, split or comment it.
• If you work on unclear code, either make it clear or mark it as unclear (think of it as the boy scout rule - leave it better than you found it).

The Coding Guidelines should not keep anybody from contributing. When somebody proposes new code that reviewers don't see as too good of a fit, very clear instructions, ideally including code changes, should be added to the review.