Skip to content

Latest commit

 

History

History
120 lines (85 loc) · 4.52 KB

open-source.md

File metadata and controls

120 lines (85 loc) · 4.52 KB

Open Source

Among else, we consider GitHub as a:

  • sales & marketing channel (clients review our code; they see how we work)
  • talent aquisition channel (we look at applicants' code; they look at our code; they see how we work)

Contents

Our Open Source Contribution Strategy

  • Extract the most useful, well-turned and successful common tasks solutions (for company and community) into open source projects under the company GitHub Ogranization profile.
  • Of course, do not publish Intellectual Propety of our clients. Just public domain stuff.
  • Give a higher priority to these frequently appearing tasks:
    • Registration & Login
    • Chats
    • Pagination / Endless Scroll
    • Push Notifications
    • Error Handling
    • Payments
    • SMS
    • Maps, Geolocation
    • Analytics
    • Validations
    • Simple and full-text search
    • Authentication / Authorization, JSON Web Tokens
    • I18n
    • L10n
  • Do not hesitate to use third-party open source projects, if they benefit us, our projects and our clients and save our time (but check the license first).
  • Invest our time to fork and make pull-requests to third-party open source projects, if that benefits us, our projects and our clients and saves our time.
  • Invest our time to support, maintain and update our open source projects (react to others developers' feedback, feature and pull requests, in particular)

Project Releases

  • Follow MLSDev Version Numbering conventions
  • We are trying to present our projects to the community in the best possible way (see Decoration section below)
  • Publish under MIT License (see below)

Decoration

Add as much useful information as possible to our open-source projects.

README

README.md file should contain:

  • Intro and some fancy but useful badges
  • Brief overview of what the project does
  • Features description
  • Requirements for a usage
  • Use cases
  • Installation instructions
  • Status (in active development, not maintained anymore etc)
  • Link to docs/wiki
  • Link to License
  • Link to Contributing guide
  • Information About MLSDev Inc (see example at the bottom of this page)

A good example can be found here.

LICENSE

All of our open source projects are licensed under MIT License.

LICENSE file should be added to repo's root directory. This file should also be mentioned in project's README file. See example snippet in Markdown:

## License

<project-name> is Copyright © 2016-2017 Denys Telezhkin and MLSDev Inc.
It is free software, and may be redistributed under the terms specified in the [LICENSE](LICENSE) file.

You can find MIT License text here: https://opensource.org/licenses/MIT

CONTRIBUTING Guide

In order to help your project contributors do a good work put a CONTRIBUTING.md file in the root directory of the repository. Anyone who opens a pull request or creates an issue will see a link to that file.

Contribution guidelines should include:

  • Steps for creating meaningful issues or valuable pull requests.
  • Links to external documentation, conventions, code of conduct etc.
  • Community and behavioral expectations.

Good Guidelines Examples:

Badges

Read more at shields.io.

About MLSDev

MLSDev.com

Development Standards are maintained by MLSDev, Inc. We specialize in providing all-in-one solution in mobile and web development. Our team follows Lean principles and works according to agile methodologies to deliver the best results reducing the budget for development and its timeline.

Find out more here and don't hesitate to contact us!