diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..1637db2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index f8c27ce..b846b84 100644 --- a/README.md +++ b/README.md @@ -1,19 +1,35 @@ -# TODO.md +# Description +Repository about how to create a TODO list using markdown. -### What is TODO.md? +# Content EN +- [What is TODO.md?](#What-is-`TODO.md`?) +- [Why keep a TODO.md?](#Why-keep-a-`TODO.md`?) +- [Why are we not using online management tools?](#Why-are-we-not-using-online-management-tools?) +- [TODO.md format](#`TODO.md`-format) +- [Examples](#examples) +- [See also](#See-also) + +---- + +## What is `TODO.md`? + +The `TODO.md` format is based on [GFM - GitHub Flavored Markdown - Task Lists](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown). -- The TODO.md format is based on [GFM - GitHub Flavored Markdown - Task Lists](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown). - TODO.md is a file that contains tasks organized in multiple sections. - Tasks in TODO.md can be visualized using [Kanban Board](https://en.wikipedia.org/wiki/Kanban_board) where sections become columns on the board. - Inspired by [Keep a Changelog](https://github.com/olivierlacan/keep-a-changelog) -### Why keep a TODO.md? +`TODO.md` is a file that contains tasks organized in multiple sections. + +Tasks in `TODO.md` can be visualized using [Kanban Board](https://en.wikipedia.org/wiki/Kanban_board) where sections become columns on the board. + +## Why keep a `TODO.md`? For a project, there any many sources of information like Documentation, Issue forum, Wiki pages, etc. It is hard to find out about the current progress. -Keeping a TODO.md file makes it easier for anyone who wants to know about the project's plans and work that needs to be done. +Keeping a `TODO.md` file makes it easier for anyone who wants to know about the project's plans and work that needs to be done. -### Why not using online management tools? +## Why are we not using online management tools? Often times, a new project starts with a list of tasks to outline what needs to be done quickly. @@ -21,40 +37,45 @@ Although some online tools are useful to manage larger projects efficiently, usi A few other reasons like: portable plain text format, same project directory, offline working, privacy, versioning (using git), minimalist tool, etc. -### TODO.md format +### `TODO.md` format -- TODO.md can have multiple columns. +- `TODO.md` can have multiple columns. - Each column has tasks that start with a checkbox sign `- [ ]` or just a hyphen `- ` - Completed column name must contain `✓` or `[x]`. - There are "2 spaces" at the end of every task title to serve as line breaks on Github pages. -- Tags, mentions, estimates, date time, ticket id, etc. can be entered at the end of the task title. -- A task with 2 space indentation in the title is a sub-task or description. +- Tags, mentions, estimate, date time, ticket id, etc. can be entered at the end of the task title. +- A task with 2 space indentation in the title is a sub-task or description. -``` +```md # Project Name Project Description ### Column Name -- [ ] Task title ~3d #type @name yyyy-mm-dd - - [ ] Sub-task or description +- [ ] Task title ~3d #type @name yyyy-mm-dd + - [ ] Sub-task or description ### Completed Column ✓ -- [x] Completed task title +- [x] Completed task title ``` - Checkboxes are used as described in [GFM - GitHub Flavored Markdown - Task Lists](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) but they are optional. - A task list without checkboxes look like this: -``` -### Column Name -- Task title ~3d #type @name yyyy-mm-dd - - Sub-task or description +```md +## Column Name +- Task title ~3d #type @name yyyy-mm-dd + - Sub-task or description ### Completed Column ✓ -- Completed task title +- Completed task title ``` -### See also +## Extra: Declined task +- [-] Example to declined task +## Examples +- [Example 1 of TODO.md](Examples_TODO/TODO.md) +- [Example 2 of TODO.md](Examples_TODO/TODO2.md) -- [An example of TODO.md](TODO.md) -- [Vscode Kanban Extension](https://bit.ly/2JcrUWJ) +## See also +- [Vscode Kanban Board Extension](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) +- [README_ES](README_ES.md) diff --git a/README_ES.md b/README_ES.md new file mode 100644 index 0000000..9024f62 --- /dev/null +++ b/README_ES.md @@ -0,0 +1,72 @@ +# Descripción +Repositorio acerca de cómo hacer una lista de TO-DO en markdown. + +# Contenido ES +- [¿Qué es un TODO.md?](#¿qué-es-un-`TODO.md`?) +- [¿Por qué dejar un TODO.md?](#¿por-qué-dejar-un-`TODO.md`?) +- [¿Por qué no usar una herramienta online?](#¿Por-qué-no-usar-una-herramienta-online?) +- [Formato del TODO.md](#formato-del-`TODO.md`) +- [Ejemplos](#ejemplos) +- [Ver también](#ver-también) +--- +## ¿Qué es un `TODO.md`? + +El `TODO.md` es un formato basado en [GFM - GitHub Flavored Markdown - Task Lists](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown). + +`TODO.md` es un archivo que contiene tareas organizadas en múltiples secciones. + +Tareas en `TODO.md` pueden ser visualizadas con [Tabla Kanban EN](https://en.wikipedia.org/wiki/Kanban_board) dónde las secciones se convierten en columnas de una tabla. + +## ¿Por qué dejar un `TODO.md`? + +Para un proyecto, hay muchas fuentes de información como: documentación, foro de problemas, la pág. de Wiki, etc. Por lo cual, es difícil conocer el progreso actual. + +Manteniendo un archivo `TODO.md` hace esto más fácil para cualquiera que quiera saber acerca del plan de proyecto y trabajar en lo que se necesite terminar. + +## ¿Por qué no usar una herramienta online? + +Más a menudo, en un nuevo proyecto se empieza con una lista de tareas para plasmar lo que se debe hacerse rápidamente. + +Aunque algunas herramientas online son útiles para manejar grandes proyectos de forma eficiente, usarlos al inicio de un proyecto (en sus primeras etapas) agregará más esfuerzo y gastos generales para un MVP (o [PVM](https://es.wikipedia.org/wiki/Producto_viable_m%C3%ADnimo)) del producto. + +### Formato del `TODO.md` + +- `TODO.md` puede tener múltiples columnas. +- Cada columna tiene tareas que comienzan con un signo de casilla de verificación `- [ ]` o solo un guión `- ` +- El nombre de columna de las tareas completas debe contener `✓` o `[x]`. +- Hay "2 espacios" al final de cada título de la tarea que sirven como salto de líneas en las pág. de Github. +- Tags, menciones, estimaciones, fecha, ticket id, etc. se puede ingresar al final del título de la tarea. +- Una tarea con 2 espacios de indexación en el título es una sub-tarea o descripción. + +```md +# Nombre del proyecto +Descripción del proyecto + +### Nombre de la columna +- [ ] Título de la tarea ~3d #tipo @nombre yyyy-mm-dd + - [ ] Sub-tarea o descripción + +### Columna completada ✓ +- [x] Título de la tarea completada +``` + +- Las casillas de verificación son usadas como se describe en [GFM - GitHub Flavored Markdown - Task Lists](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) pero esto es opcional. +- Una lista de tareas sin casilla de verificación se ve como esto: + +```md +## Nombre de la columna +- Título de la tarea ~3d #tipo @nombre yyyy-mm-dd + - Sub-tarea o descripción + +### Columna completada ✓ +- Título de la tarea completada +``` +## Extra: Tareas rechazadas +- [-] Ejemplo de tarea rechazada +## Ejemplos +- [Ejemplo 1 de TODO.md](TODO_examples/TODO.md) +- [Ejemplo 2 de TODO.md](TODO_examples/TODO2.md) + +## Ver también +- [Extensión de Vscode: Kanban Board](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) +- [README EN](README.md) \ No newline at end of file diff --git a/TODO.md b/TODO.md deleted file mode 100644 index 24ef082..0000000 --- a/TODO.md +++ /dev/null @@ -1,19 +0,0 @@ -# Example of TODO.md - -This is an example of TODO.md - -View the raw content of this file to understand the format. - -### Todo - -- [ ] Work on the website ~3d #feat @john 2020-03-20 -- [ ] Fix the homepage ~1d #bug @jane - - [ ] Sub-task or description - -### In Progress - -- [ ] Work on Github Repo [JIRA-345] - -### Done ✓ - -- [x] Create my first TODO.md \ No newline at end of file diff --git a/TODO_examples/TODO.md b/TODO_examples/TODO.md new file mode 100644 index 0000000..ef8b273 --- /dev/null +++ b/TODO_examples/TODO.md @@ -0,0 +1,19 @@ +# Example of TODO.md + +This is an example of [TODO.md](TODO.md) + +View the raw content of this file to understand the format. + +### Todo + +- [ ] Work on the website ~3d #feat @john 2020-03-20 +- [ ] Fix the homepage ~1d #bug @jane + - [ ] Sub-task or description + +### In Progress + +- [ ] Work on Github Repo [JIRA-345] + +### Done ✓ + +- [x] Create my first [TODO.md](TODO.md) \ No newline at end of file diff --git a/TODO_examples/TODO2.md b/TODO_examples/TODO2.md new file mode 100644 index 0000000..b15fb98 --- /dev/null +++ b/TODO_examples/TODO2.md @@ -0,0 +1,31 @@ +# My contribution on TODO.md (@shirosweets) +Use **P0**, **P1**, **P2**, **P3** at the end for priorities. Optional items can be **P3**. + +### Todo + +- [ ] Add autor (P3) +- [ ] Add contributors (P2) + +### In progress + +- [ ] Add dynamic contributions (P3) + +### Follow up + +- [ ] Accept PR (P1) + +### Done ✓ + +- [x] Fork repositorie (P0) +- [x] Create [TODO2.md](TODO_examples/TODO2.md) (P0) +- [x] Add commits (P0) +- [x] Push my commits to Github repository (P0) +- [x] Add changes solicited + - [x] Fix LICENSE (P1) + - [x] Rename directory `examples_TODO` to `TODO_examples` (P1) + -[x] Fix relative path (P2) + - [x] Keep the existing `README.md` and duplicate it to `README_ES.md` for ES language (P1) + - [x] Set prority in `TODO2.md` (P2) + - [x] Change Optional in `TODO2.md` (P1) + - [x] Use **P3** to Optional (P2) + - [x] Change description (P2) \ No newline at end of file