GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → vgpena → gh-docs-boilerplate

vgpena / gh-docs-boilerplate

Licence: other
The basic documentation that should be included in any project on github.

Labels

githubdocumentationautomationproject-management

Projects that are alternatives of or similar to gh-docs-boilerplate

workflowr
Organize your project into a research website
Stars: ✭ 747 (+3635%)
Mutual labels:  project-management
meta
Ellaism Project Management
Stars: ✭ 13 (-35%)
Mutual labels:  project-management
iguana
Iguana is an open source issue management system with a kanban board.
Stars: ✭ 39 (+95%)
Mutual labels:  project-management
projectile
An app for managing your JavaScript projects
Stars: ✭ 128 (+540%)
Mutual labels:  project-management
springcrm
An open-source CRM.
Stars: ✭ 14 (-30%)
Mutual labels:  project-management
teammanager
Small team manager written in MEAN stack
Stars: ✭ 30 (+50%)
Mutual labels:  project-management
general-interview-questions
Project Management Basics
Stars: ✭ 52 (+160%)
Mutual labels:  project-management
nl-covid19-notification-app-community-website
Community website COVID-19 notificatieapp
Stars: ✭ 17 (-15%)
Mutual labels:  project-management
awesome-engineering-management
Pointers and tools for learning and day-to-day practice of engineering management & leadership.
Stars: ✭ 1,535 (+7575%)
Mutual labels:  project-management
bookmarks
A PySide2 based file and asset manager for animation and CG productions.
Stars: ✭ 33 (+65%)
Mutual labels:  project-management
trackie
⏳ trackie is a private, daemon-less time tracker for your CLI.
Stars: ✭ 39 (+95%)
Mutual labels:  project-management
yoda
GitHub extension for agile project management, using the issues subsystem.
Stars: ✭ 86 (+330%)
Mutual labels:  project-management
sigmah
Open source software for managing international aid projects
Stars: ✭ 22 (+10%)
Mutual labels:  project-management
Laravel-Project-mgmt
A Laravel Project Management Tool
Stars: ✭ 17 (-15%)
Mutual labels:  project-management
project-management
A basic CLI for regularly updating your project's status
Stars: ✭ 90 (+350%)
Mutual labels:  project-management
phpcollab
Project management and collaboration over the internet.
Stars: ✭ 42 (+110%)
Mutual labels:  project-management
treetime
TreeTime is a data organisation, management and analysis tool. A tree is a hierarchical structure that arranges information in units and sub-units. TreeTime uses linked trees (one data item can be part of different distinct trees) to store and organise any general purpose data.
Stars: ✭ 26 (+30%)
Mutual labels:  project-management
links-uteis
📎 A curated list of awesome project development links
Stars: ✭ 2,547 (+12635%)
Mutual labels:  project-management
API
API documentation for the Forecast platform
Stars: ✭ 24 (+20%)
Mutual labels:  project-management
kanbanize
Triage issues on github project boards.
Stars: ✭ 32 (+60%)
Mutual labels:  project-management
View All Similar Projects ➔

Github Docs Boilerplate

This repo is a template for projects on github. Specifically, it is an example of the documentation and project management tools that should be included in any project.

Installation

If you are starting a project from scratch and will host the code on Github, hit the "Use this template" button above the code to get started. If you will host elsewhere, clone this repo and start your project from there.

Usage

These files only change how your project behaves on github, and most of them will only take effect once merged into your default branch (usually master or dev).

Keep them up-to-date as your project evolves.

Contents

Here's a rundown of the files included, as well as why they're important:

Readme

Every project should have a Readme (usually a Markdown file). It should describe your specific project and have at least three sections:

  1. Project Name and description.
  2. Installation List any major dependencies, system requirements, and gotchas.
  3. Usage How to run the project.

Pull Request Template

This Markdown file prepopulates new Pull Requests. Using it as a prompt helps team members write infomative pull requests, makes code easier to test, and leaves a paper trail of code and decisions.

It can live in the /.github folder, the /docs folder, or the project root.

Issue Template

Issue templates benefit developers and any other team members who may be performing QA or developing project requirements.

These markdown files prepopulate new Issues filed on github. When a team member files an issue, they are given different prompts based on what type of issue they are creating. For example, a Bug issue template may include steps to reproduce, and a CMS template may include optional vs. required fields.

You can create as many issue templates as you want. They live in the /.github/ISSUE_TEMPLATE directory.

Each issue template needs to start with this markup:

---
name: Issue Type
about: Further description of this category.

---

This frontmatter will be used to populate the Issue Picker UI in Github.

Other things to explore

  • Steve Mao has a huge repository of issue templates here
  • This repo contains the essentials for running any project, but if your project is community-based, you should leverage additional documentation such as a code of conduct, changelong, and contribution guidelines.
Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].