Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation #18

Open
2 of 6 tasks
dannycolin opened this issue Aug 23, 2018 · 1 comment
Open
2 of 6 tasks

Documentation #18

dannycolin opened this issue Aug 23, 2018 · 1 comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@dannycolin
Copy link
Member

dannycolin commented Aug 23, 2018

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 :).

  • How to install Jekyll locally (see Migrate to Hugo #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
    • 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 dannycolin added enhancement New feature or request help wanted Extra attention is needed labels Aug 23, 2018
@Protohedgehog
Copy link
Contributor

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

@dannycolin dannycolin added this to the 1.0.0 milestone Nov 17, 2018
@dannycolin dannycolin modified the milestones: 1.0.0, Future Jul 9, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants