Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Initial project documentation #32

Merged
merged 1 commit into from
Nov 9, 2020
Merged

Initial project documentation #32

merged 1 commit into from
Nov 9, 2020

Conversation

svengreb
Copy link
Owner

@svengreb svengreb commented Nov 9, 2020

Resolves #31

@svengreb
Initial project documentation
cb4ef1d 
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. ...an overview of the directory structure.
4. ...more detailed sections about all features.
5. ...some basic instructions how to use this template repository.
6. ...information about references used for this template repository.
7. ...information about how to contribute to this project.

Each directory documented in step 3 contains an individual documentation
with more detailed information about it.
The `package.json` file has been extended to include the
Yarn [1] / NPM [2] `workspaces` field.

[1]: https://classic.yarnpkg.com/docs/workspaces
[2]: https://docs.npmjs.com/cli/v7/using-npm/workspaces

GH-31
@svengreb svengreb added this to the Next milestone Nov 9, 2020
@svengreb svengreb self-assigned this Nov 9, 2020
@svengreb svengreb merged commit d1a77a3 into main Nov 9, 2020
@svengreb svengreb deleted the feature/gh-31-initial-project-docs branch November 9, 2020 19:00
@svengreb svengreb removed their assignment Nov 9, 2020
@svengreb svengreb mentioned this pull request Nov 10, 2020
Closed
svengreb added a commit to svengreb/nib that referenced this pull request Nov 11, 2020
@svengreb
Update to "tmpl-go" template repository version 0.5.0
a32fd58 
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

GH-25
svengreb added a commit to svengreb/nib that referenced this pull request Nov 11, 2020
@svengreb
Update to "tmpl-go" template repository version 0.5.0 (#26)
eaef697 
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

Closes GH-25
svengreb added a commit to svengreb/nib that referenced this pull request Nov 11, 2020
@svengreb
Update to "tmpl-go" template repository version 0.5.0 (#26)
15285fb 
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

Closes GH-25
@svengreb svengreb mentioned this pull request Nov 12, 2020
Closed
svengreb added a commit to svengreb/wand that referenced this pull request Nov 12, 2020
@svengreb
Update to "tmpl-go" template repository version 0.5.0
b37945f 
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

GH-4
svengreb added a commit to svengreb/wand that referenced this pull request Nov 12, 2020
@svengreb
Update to "tmpl-go" template repository version 0.5.0 (#5)
f778fd9 
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

Closes GH-4
svengreb added a commit to svengreb/wand that referenced this pull request Nov 12, 2020
@svengreb
Update to "tmpl-go" template repository version 0.5.0 (#5)
4176fc7 
Updated to `tmpl-go` version 0.5.0 [1] (including version 0.4.0 [2])
that...

1. ...introduces the initial project documentation [3].
2. ...updates golangci-lint to the currently latest version 1.32.0 [4]
   which introduces new linters like errorlint [5], tparallel [6] and
   wrapcheck [7].
3. ...updates to "tmpl" version 0.7.0 (GH-25 [8] GH-34 [9]).
   This includes...
   - ...a new configuration file for automated dependency updates and
     security alerts [10] with Dependabot [11]. Next to update
     configurations for the CI/CD GitHub action workflow [12] and
     Yarn/NPM dependencies [13], the file has been extended to support
     Go modules [14].
   - ...updates to the latest Node.js package dependency & GitHub Action
     versions.
   - ...a change of the NPM package name to use a namespace [15] which
     helps to prevent collisions with already existing NPM packages like
     tmpl [16].

[1]: https://github.com/svengreb/tmpl-go/releases/tag/v0.5.0
[2]: https://github.com/svengreb/tmpl-go/releases/tag/v0.4.0
[3]: svengreb/tmpl-go#32
[4]: svengreb/tmpl-go#21
[5]: https://github.com/polyfloyd/go-errorlint
[6]: https://github.com/moricho/tparallel
[7]: https://github.com/tomarrell/wrapcheck
[8]: svengreb/tmpl-go#25
[9]: svengreb/tmpl-go#34
[10]: svengreb/tmpl#52
[11]: https://dependabot.com
[12]: https://github.com/svengreb/tmpl#cicd-action-workflow
[13]: https://github.com/svengreb/tmpl#nodejs-yarn-and-npm
[14]: https://golang.org/ref/mod
[15]: svengreb/tmpl#48
[16]: https://www.npmjs.com/package/tmpl

Closes GH-4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
context-documentation context-techstack scope-maintainability scope-quality scope-ux type-feature
Projects
None yet
Milestone
0.5.0
Development

Successfully merging this pull request may close these issues.

Initial project documentation
1 participant
@svengreb