blank-workspace

Blank workspace [template]

https://github.com/dro-id/blank-workspace

Repository

Blank workspace [template]

README.adoc

= README
:doctype: article
:fragment:
:repository-url: https://github.com/dro-id/blank-template
:!showtitle:
:icons: font
:imagesdir: docs/assets/img
:hardbreaks-option:
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:

// Standard shields and technology skills

++++

  
  
  
  
  
  
  
  



++++

// Header

++++

	
░░░▄▀▄░█░█░▄▀▄░▀█░░░░░░▀█▀░█▀▀░█▄█░█▀█░█░░░█▀█░▀█▀░█▀▀░░░░
░░░█/█░▄▀▄░█/█░░█░░▄▄▄░░█░░█▀▀░█░█░█▀▀░█░░░█▀█░░█░░█▀▀░░░░
░░░░▀░░▀░▀░░▀░░▀▀▀░░░░░░▀░░▀▀▀░▀░▀░▀░░░▀▀▀░▀░▀░░▀░░▀▀▀░░░░
	
Blank Project [template]
	

		A blank workspace template to kickstart a new awesome stacks and projects!
		


    
		

	

++++

// Content

[TIP]
====
This repository contains a base, stack agnostic, template to kickstart new projects.
- *Codespace ready* with a .devcontainer and the actual environment defined with `devenv`
- Base *GitHub Actions workflow* ready to be adapted for a target stack
- Simple Issue and Pull Request template in markdown
- EditorConfig base configuration to standardise some editor settings across devs
- (Optional) Set of *repository special files* in the / root and docs directory to materialize project governance.

__ -> Just adapt / remove the things you do not need!__
====

=== About

Purpose and rational behind the repository

=== Features

* 🚀 Feature 1
* 🚀 Feature 2

🔜 TODO

* [ ] Do that
* [ ] Do that

=== Installation

. Step 1
[source,bash]
----
  code here
----

. Step 2
[source,bash]
----
  code here
----

=== Getting Started

. Step 1
. Step 2

=== Contributing

[TIP]
====
* Reference link:./docs/CONTRIBUTING.adoc[CONTRIBUTING] to unclutter the README if you have a bigger community.
* Reference link:./docs/GOVERNANCE.adoc[GOVERNANCE] to unclutter the README if you have a bigger community.
* Reference link:./docs/CODE_OF_CONDUCT.adoc[CODE_OF_CONDUCT] to unclutter the README if you have community.
====

Feel free to suggest improvements to the template!

=== Acknowledgements

[TIP]
====
* Reference link:./docs/ACKNOWLEDGMENTS.adoc[ACKNOWLEDGMENTS] to a have a full list of dependencies.
====

Big thanks to all those great projects and their maintainers.

* https://devenv.sh/[devenv] - Defining development environments as-code
* https://starship.rs/[starship] - Awesome cross-shell prompt
* https://containers.dev[devcontainer] - Standardizng development environment as-code
* https://github.com/features/codespaces[GitHub Codespace] - Development environments in the octosphere

=== License

⚖️ link:./LICENSE[MIT]

=== Authors

[TIP]
====
* Reference link:./docs/AUTHORS.adoc[AUTHORS] to unclutter the README if you have a bigger community.
* Reference link:./docs/CONTRIBUTORS.adoc[CONTRIBUTORS] to unclutter the README if you have community.
====

👨🏻‍💻 https://github.com/marc-0x01[@marc-0x01]

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "FamilyNames"
  given-names: "GivenNames"
  orcid: "https://orcid.org/0000-0000-0000-0000"
- family-names: "FamilyNames"
  given-names: "GivenNames"
  orcid: "https://orcid.org/0000-0000-0000-0000"
title: "The title of your paper"
version: 1.0.0
doi: 10.1007/s10664-021-10061-x
date-released: 2021-11-16
url: "https://github.com/SOM-Research/NonCodingRoleAnalysis-NPMPackages"
preferred-citation:
  type: article
  authors:
  - family-names: "FamilyNames"
    given-names: "GivenNames"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  - family-names: "FamilyNames"
    given-names: "GivenNames"
    orcid: "https://orcid.org/0000-0000-0000-0000"
  doi: "10.1007/s00000-000-00000-x"
  journal: "JournalName"
  month: 1
  start: 1 # First page number
  end: 100 # Last page number
  title: "The title of your paper"
  issue: 1
  volume: 29
  year: 2022

GitHub Events