[WIKI] Dev Guide: Code Conventions

kblincoe / VisualGit_SE701_2019_1

1 stars 0 forks source link

[WIKI] Dev Guide: Code Conventions #241

Closed rmberriman closed 5 years ago

rmberriman commented 5 years ago

Description In the Developer Guide section of the Wiki, under Setting Up Development Environment, the Code Conventions page needs relevant information for future developers to use.

Or alternatively, this page needs to be removed if no longer deemed necessary.

Acceptance criteria

A description of project code conventions for the developer should be on the Wiki here
Possibly include some screenshots or gifs

Related issues None

bcox280 commented 5 years ago

Approved, this should also follow the setup we have for the linter.

darcycox97 commented 5 years ago

oscarcs commented 5 years ago

I've added some information based on the tslint config file.

One thing I noticed while doing this is that some of the config files don't actually conform to this guide (e.g. they use 4-space indentation). Might be worth opening another issue for that.

rmberriman commented 5 years ago

Looks good - maybe edit the content under 3 to be in line with the numbers.

I agree that a separate issue should be opened to resolve the issues in the config files.

oscarcs commented 5 years ago

I don't think there's a way to do that with Markdown, unfortunately. Can we close this?

swimuel commented 5 years ago

Looks good to me.