site icon indicating copy to clipboard operation
site copied to clipboard

Documentation

Open dannycolin opened this issue 6 years ago • 1 comments

Here's a list of things I think we could add to the documentation. If you think about anything else just let me know and I'll add it to the list. Also, there's a CONTRIBUTING.md file in the devel branch that's where I'm going to add stuff because I want to keep the README.md as short as possible :).

  • [x] ~~How to install Jekyll locally~~ (see #50)
  • [ ] Quick guide/cheat sheet to use/remember git command (e.g. difference between git pull and git pull --rebase and when to use them)
  • [ ] Styleguide for the code
  • [ ] Naming convention
  • Issue template
    • [x] Bugreport
    • [ ] Feature Request

We could also reuse this documentation and/or part of it for the other repository we have or even the future one.

dannycolin avatar Aug 23 '18 22:08 dannycolin

This is perfect for now, thanks @dannycolin! :)

Protohedgehog avatar Aug 24 '18 01:08 Protohedgehog