Skip to content

Instantly share code, notes, and snippets.

@hontas hontas/README.md

Last active Aug 29, 2015
Embed
What would you like to do?
Base project README

Project name

optional tagline

Short description of what it is and what it does. Possibly even what it does not.

Local setup

  • Minimum possible steps
  • developer need take to start developing
  • and getting the application running
# preferably containing som terminal instructions such as
npm install -g nodemom
npm install
npm start

Configuration

What can and/or should be configured

Package.json

  • Should have postinstall, start and test defined
  • postinstall should build aplication
  • start should start local dev env
  • test should run all tests, including linting and stylistic tests
  • Favor npm run-commands for all tasks

Branching strategy

How do we work in this project?
Only with pull-requests / feature branching
or simply directly against master.

Important master should always be in deployable state

Testing strategy

  • What framework and what kind of tests
  • Unit tests in test/unit for ...
  • E2E tests using Nightwatch in tests/e2e
  • Links to all referenced frameworks

How to deploy

  1. List steps needed for this
  2. To deploy do:
npm run deploy production

Versioning

Always use Semantic versioning: MAJOR.MINOR.PATCH (ex. 0.2.41)

  • MAJOR version when you make incompatible API changes,
  • MINOR version when you add functionality in a backwards-compatible manner, and
  • PATCH version when you make backwards-compatible bug fixes.

Changelog

v.0.0.1

  • list of most
  • important
  • changes and
  • BUG-fixes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.