tuwien2020 / tgi-pages

Open tools for the TGI course at the TU Vienna

Home Page:https://tuwien2020.github.io/tgi-pages/#/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Extending CONTRIBUTING.md

Fancy11111 opened this issue · comments

Helping new Contributors

Currently, writing new features, fixing bugs and refactoring/redesigning pages is a bit intimidating at first.

Fixing bugs and refactoring is manageable, but contributing new pages or features would be a lot easier if a quick guide was provided for new devs.

  • what is the project structuring (does all code for a page go into the page .ts file or is there code splitting?)
  • where do new pages go
  • how do I register my pages and make them findable

We should probably write a quick introduction to the project structure to make this easier for new devs.

This should not be a tutorial on how to develop with Vue, but an overview would still be helpful.

Here is an example of a CONTRIBUTING.md I wrote for some other tool https://github.com/stefnotch/quantum-sheet/blob/master/CONTRIBUTING.md

@Fancy11111 Quick heads up: I copied over the CONTRIBUTING.md from the other tool and edited it accordingly: https://github.com/tuwien2020/tgi-pages/blob/main/CONTRIBUTING.md

It's not quite done though, I'd say