Giter VIP home page Giter VIP logo

open-development-template's Introduction

Open Development Template

Documentation templates that help teams and projects formalize their mission, workflow (or process), licensing and governance to encourage participation, field contributions and help grow a community.

Goals

This project provides templates for project documentation that:

  • makes it easy for newcomers to a project to get involved (creates an environment with a low barrier to entry)
  • enables maintainability as a project grows (scales up)

Why?

Source of Truth

Documentation makes things explicit and that is helpful for the mushy, social things templated in this project.

Framework for Change

Formalizing the described aspects of a project allows for a mediated means of changing how these aspects work. That is, by formalizing a project's e.g. objectives, it gives project members a means for changing the project's objectives through a peer review (patch submission / pull request) system that most (software) projects are familiar with.

Components

  • Mission: What are the goals of the project?
  • Governance: How are decisions made in the project? What are the human or social rules that should be followed in the project? What is the social framework for collaboration in the project?
  • Licensing: How can I use the project? How can I contribute to the project? What is the legal framework for collaboration in the project?
  • Process: How is work done in the project? How do we implement the project's Governance to give project contributors structure in how they do their work?

Each component describes why and how to document each aspect of a project and provides examples.

Contributing

Thanks for thinking about contributing to this project! Check out our contribution guidelines for information on how to get involved.

open-development-template's People

Contributors

filmaj avatar majtest583 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.