Skip to content

rosettastone/Contributing

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Contributing

Open source guidelines and project setup

Goals

The purpose of this repo is to establish the expectations and requirements that govern all existing and future open source projects at Rosetta Stone.

Contents

Materials to be included with all open-source distributions:

Project Guidelines

Where applicable, all projects should:

  1. Contain a copy of LICENSE
  • Contain a link to CONTRIBUTING.md
  • Provide 100% documentation
  • Provide sufficient unit test coverage
  • Use Semantic Versioning
  • Integrate with Travis-CI
  • Include a descriptive, helpful README.md
  • Include an example project or demo

Code

All files should contain the following header comment:

//
//  Rosetta Stone
//  http://product.rosettastone.com/news/
//
//
//  Documentation
//  <link to project documentation, if applicable>
//
//
//  GitHub
//  <link to project github>
//
//
//  License
//  Copyright (c) <year> Rosetta Stone
//  Released under a BSD license: http://opensource.org/licenses/BSD-3-Clause
//