Giters

IRNAS / irnas-guidelines-docs

This repository contains guidelines related to various aspects of managing GitHub repositories at IRNAS and working with them.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Define minimal structure of Github software/firmware project and automate it

MarkoSagadin opened this issue · comments

commented

Context

There is currently no defined structure how should a GitHub project look like. We do not define what should be written in README, if CHANGELOG should be written or not, where additional documentation can be found, how should bug reports, feature requests look like and so on.

Goal

Create a template repository that developers can use to start a new project.
That way projects will start to be more unified, each developer/manager will know where to look for something.

Detailed steps

  1. Use GitHubs template repository feature: https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository

Template should contain:

  • Branches master and dev
  • Template for bug reports
  • Template for feature requests
  • Defined issue labels
  • Gitignore file that is well documented and suitable for all projects.
  • Basic README template, which developer should fill at out.
  • CHANGELOG file
commented

This is done now, template repo now contains the labove list of things.