Skip to content

Commit

Permalink
Initial project documentation (#51)
Browse files Browse the repository at this point in the history
Wrote the initial project documentation for the `README.md` file that
includes...

1. ...an project introduction and motivation.
2. ...an overview of the project features.
3. ...a listing of available template repositories.
4. ...a rough overview of the directory structure.
5. ...more detailed sections about all features.
6. ...some basic instructions how to use this template repository.
7. ...information about how to contribute to this project.

Closes GH-50
  • Loading branch information
svengreb committed Nov 2, 2020
1 parent 242f166 commit f18bf43
Show file tree
Hide file tree
Showing 4 changed files with 274 additions and 5 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<p align="center"><a href="https://github.com/svengreb/tmpl/releases/latest"><img src="https://img.shields.io/github/release/svengreb/tmpl.svg?style=flat-square&label=Release&logo=github&logoColor=eceff4&colorA=4c566a&colorB=88c0d0"/></a></p>

<p align="center">Changelog for the collection of <a href="https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository" target="_blank">repository templates</a> for new projects.</p>
<p align="center">Changelog for the collection of <a href="https://docs.github.com/en/github/creating-cloning-and-archiving-repositories/creating-a-template-repository" target="_blank">template repositories</a> for new projects.</p>

<!--lint disable no-duplicate-headings no-duplicate-headings-in-section-->

Expand Down Expand Up @@ -292,7 +292,7 @@ To allow to run the Markdown linting separately a `lint:md` package script has b
[Git Hooks][git-docs-hooks] are a fantastic way to customize the development workflow of a project to simplify and automate specific tasks that are required when working on the code base. For example, this includes tasks like formatting, _linting_ and running tests before pushing a commit to ensure it conforms to the code style and works as expected.
Most _Git Hooks_ are not that complex and fullfil a simple purpose while other solutions like [Danger][] can help to manage larger projects and projects that need to scale.

This _base_ repository template will initially use a _Git Hook_ that automatically runs configured _linters_ on all files that have been _staged_ and that match the configured pattern (file extension, filename etc.).
This _base_ template repository will initially use a _Git Hook_ that automatically runs configured _linters_ on all files that have been _staged_ and that match the configured pattern (file extension, filename etc.).
Like documented in #15, [NodeJS][] is already a development dependency anyway so the [lint-staged][] NPM package will be used for this goal. I‘ve used this package in almost any project and it‘s again the most stable, production-proven and advanced tool that is currently out there with no comparable alternatives in other languages.

<p align="center"><a href="https://asciinema.org/a/199934"><img src="https://asciinema.org/a/199934.svg" width="600" /></a></p>
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before you continue with these contribution guidelines we highly recommend to re

### Repository Assignment

tmpl is [a modular project][gh-profile-repo-search] of multiple [GitHub repository templates][ghd-repos-tmpl]. Each repository has a different focus for different use cases, project structures and programming languages.
tmpl is [a modular project][gh-profile-repo-search] of multiple [template repositories][ghd-repos-tmpl]. Each repository has a different focus for different use cases, project structures and programming languages.

**Please make sure to determine the correct repository before you continue!**
Contributions related to a [specialized template][gh-profile-repo-search] belongs to the specific repository while contributions related to [this base template][gh-tmpl] are welcome in this repository. This helps all core team members, committers and maintainer to process every contribution faster without organization overhead.
Expand Down
Loading

0 comments on commit f18bf43

Please sign in to comment.