A template for f/e open source projects
JavaScript Shell
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
build
docs
examples
lib
scripts
.editorconfig
.eslintignore
.eslintrc
.flowconfig
.gitignore
LICENSE.md
README.md
package.json
webpack.config.js

README.md

Run scripts/configure when you first clone this repo.

Open Source Template

Join the chat at https://gitter.im/Chrisui/PROJECT

A simple open source project template geared towards f/e open source projects! You will want to update this readme for your own project.

Overview

Quick overview of the project fundamentals, philosophies and specific features to go here.

Quick Example

// Raw and dirty code example can go here...

Install

npm install project

or use the old-skool UMD packaged library found in /build/global.

Basic Usage

import Project from  'project';
// Usage code here...

Documentation

The Getting Started guide is probably a good first point of call!

You can find full docs in the /docs folder and generated api docs in /docs/api.

You may also find various helpful example projects in the /examples folder.

Support

  • Get in touch on the Gitter room
  • Submit an issue here on GitHub

More information and links on how best to find support for the project to go here.

Contribute

Awesome! Contributions of all kinds are greatly appreciated. To help smoothen the process we have a few non-exhaustive guidelines to follow which should get you going in no time.

Using GitHub Issues

  • Feel free to use github issues for questions, bug reports, and feature requests
  • Use the search feature to check for an existing issue
  • Include as much information as possible and provide any relevant resources (Eg. screenshots)
  • For bug reports ensure you have a reproducible test case
    • A pull request with a breaking test would be super preferable here but isn't required

Submitting a Pull Request

  • Squash commits
  • Lint your code with eslint (config provided)
  • Include relevant test updates/additions

Thanks

Any special thanks or credits can go here.

License

MIT