Skip to content

Documentation work items #201

@ghost

Description

This issue is here to track the progress of updating, trimming down, and adding to the current Zen Audio Player docs & wiki pages. The four files/sections for docs are as follows: CONTRIBUTING.md, ISSUE_TEMPLATE.md, PULL_REQUEST_TEMPLATE.md, and the Wiki pages.
The main tasks that we are prospectively looking to address are:

  • Decide what amount of content to move from markdown files (Contributing, Issues, PRs), to Wiki pages (I think the issue & PR templates are too verbose, we should have a simpler checklist for both, ideally under 5 items)
  • How to test things locally (WAMP, MAMP, XAMPP) vs. opening the index.html file in a browser (we should recomment just running npm install then npm start for "running" the site, then npm test to run the tests - the main requirement here is Node.js 4.0+)
  • How to write tests & run tests
  • What are our code conventions/style? (a .jshintrc would help a bunch here) (see .eslintrc.json, coordinate those rules with the eslint docs and we could make something more human readable on the wiki)
  • How to install dependencies (frontend & test) (npm install for "running" and testing, bower (frontend) depdendencies are checked in, but in order to update I believe you run bower update --save <package-name>)
  • What to look for in a successful/unsuccessful work session (nothing specific here, but the goal is always to minimize the diff, ie: don't go refactoring unless it's necessary because the diff becomes difficult to review)
  • Tools (why did we pick certain things? bower/node.js/specific dependencies/gitter/travis CI) - (there are some notes in @shakeelmohamed's blog post ping him for any additional info)
  • What is the contributing process like? (@shakeelmohamed's code review on the PR, contributor updates PR, repeat until everyone is satisfied)
  • How to get started quickly as a newbie
  • Branching model (basically master is locked down, and can only be pushed to via a PR that passes code review)

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions