From d38d6123935e99cbdd55bb568ae31573d4ca4f4d Mon Sep 17 00:00:00 2001 From: Valentina Date: Wed, 5 May 2021 15:00:37 -0300 Subject: [PATCH 1/5] Add changes --- Examples_TODO/TODO.md | 19 +++++ Examples_TODO/TODO2.md | 20 ++++++ LICENSE | 21 ++++++ README.md | 157 ++++++++++++++++++++++++++++++++++------- TODO.md | 19 ----- 5 files changed, 193 insertions(+), 43 deletions(-) create mode 100644 Examples_TODO/TODO.md create mode 100644 Examples_TODO/TODO2.md create mode 100644 LICENSE delete mode 100644 TODO.md diff --git a/Examples_TODO/TODO.md b/Examples_TODO/TODO.md new file mode 100644 index 0000000..ef8b273 --- /dev/null +++ b/Examples_TODO/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/Examples_TODO/TODO2.md b/Examples_TODO/TODO2.md new file mode 100644 index 0000000..cb87110 --- /dev/null +++ b/Examples_TODO/TODO2.md @@ -0,0 +1,20 @@ +# My contribution on TODO.md (@shirosweets) + +### Todo + +- [ ] \(Optional) Add autor +- [ ] Add contributors + +### In progress +- [ ] \(Optional) Add dynamic contributions + +### Follow up + +- [ ] Accept PR + +### Done ✓ + +- [x] Fork repositorie +- [x] Create [TODO2.md](Examples_TODO/TODO2.md) +- [x] Add commits +- [x] Push my commits to Github repository diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4c95f71 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2021 shirosweets + +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 76afcf1..6d0448b 100644 --- a/README.md +++ b/README.md @@ -1,59 +1,168 @@ -# TODO.md +# Description +[EN] Repositorie about how to do TO-DO list on markdown. + +# Content EN +- [Structure of directories](#Structure-of-directories) +- [What is TODO.md?](#What-is-`TODO.md`?) +- [Why keep a TODO.md?](#Why-keep-a-`TODO.md`?) +- [Why not using online management tools?](#Why-not-using-online-management-tools?) +- [TODO.md format](#`TODO.md`-format) +- [Examples](#examples) +- [See also](#See-also) + +# Contenido ES +- [Estructura de los directorios](#Estructura-de-los-directorios) +- [¿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) +---- +## Structure of directories +```txt +. +├── README.md +├── LICENSE +└── Examples_TODO + └── TODO.md + └── TODO2.md + └── TODO3.md + └── TODO[..].md +``` -### What is TODO.md? +## 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. +`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. +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? +## 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 wants to know about the project's plans and work needs to be done. +Keeping a `TODO.md` file makes it easier for anyone wants to know about the project's plans and work needs to be done. -### Why not using online management tools? +## Why not using online management tools? -Most often, a new project starts with a list of tasks to outline what needs to be done quickly. +Most often, a new project starts with a list of tasks to outline what needs to be done quickly. Although some online tools are useful to manage large projects efficiently, using them in early stages will add more effort and overhead for an MVP Product. -### 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, 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. +- 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 +``` +## 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) + +## See also +- [Vscode Kanban Board Extension](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) +- [Vscode Kanban Extension](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) + +--- +## Estructura de los directorios +```txt +. +├── README.md +├── LICENSE +└── Examples_TODO + └── TODO.md + └── TODO2.md + └── TODO3.md + └── TODO[..].md +``` +## ¿Qué es un `TODO.md`? + +El `TODO.md` format is based on [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 ``` -### See also +- 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: + +```md +## Nombre de la columna +- Título de la tarea ~3d #tipo @nombre yyyy-mm-dd + - Sub-tarea o descripción -- [An example of TODO.md](TODO.md) -- [Vscode Kanban Extension](https://bit.ly/2JcrUWJ) \ No newline at end of file +### Columna completada ✓ +- Título de la tarea completada +``` +## Extra: Tareas rechazadas +- [-] Ejemplo de tarea rechazada +## Ejemplos +- [Ejemplo 1 de TODO.md](Examples_TODO/TODO.md) +- [Ejemplo 2 de TODO.md](Examples_TODO/TODO2.md) + +## Ver también +- [Extensión de Vscode: Kanban Board](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) +- [Extensión de Vscode: Kanban](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) \ 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 From 40fa865495b452f04b1f1d20a501f193c1446c48 Mon Sep 17 00:00:00 2001 From: Valentina Date: Mon, 10 May 2021 10:34:01 -0300 Subject: [PATCH 2/5] Minor changes solicited --- LICENSE | 2 +- README.md | 88 ++---------------------------------------- README_ES.md | 85 ++++++++++++++++++++++++++++++++++++++++ TODO_examples/TODO.md | 19 +++++++++ TODO_examples/TODO2.md | 30 ++++++++++++++ 5 files changed, 139 insertions(+), 85 deletions(-) create mode 100644 README_ES.md create mode 100644 TODO_examples/TODO.md create mode 100644 TODO_examples/TODO2.md diff --git a/LICENSE b/LICENSE index 4c95f71..1637db2 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 shirosweets +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 diff --git a/README.md b/README.md index 6d0448b..95ab68e 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ # Description -[EN] Repositorie about how to do TO-DO list on markdown. +Repositorie about how to do TO-DO list on markdown. # Content EN - [Structure of directories](#Structure-of-directories) @@ -10,14 +10,7 @@ - [Examples](#examples) - [See also](#See-also) -# Contenido ES -- [Estructura de los directorios](#Estructura-de-los-directorios) -- [¿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) + ---- ## Structure of directories ```txt @@ -45,7 +38,7 @@ For a project, there any many sources of information like Documentation, Issue f Keeping a `TODO.md` file makes it easier for anyone wants to know about the project's plans and work needs to be done. -## Why not using online management tools? +## Why are we not using online management tools? Most often, a new project starts with a list of tasks to outline what needs to be done quickly. @@ -92,77 +85,4 @@ Project Description ## See also - [Vscode Kanban Board Extension](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) - [Vscode Kanban Extension](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) - ---- -## Estructura de los directorios -```txt -. -├── README.md -├── LICENSE -└── Examples_TODO - └── TODO.md - └── TODO2.md - └── TODO3.md - └── TODO[..].md -``` -## ¿Qué es un `TODO.md`? - -El `TODO.md` format is based on [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 -``` - -- 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: - -```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](Examples_TODO/TODO.md) -- [Ejemplo 2 de TODO.md](Examples_TODO/TODO2.md) - -## Ver también -- [Extensión de Vscode: Kanban Board](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) -- [Extensión de Vscode: Kanban](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) \ No newline at end of file +- [README_ES](README_ES.md) \ No newline at end of file diff --git a/README_ES.md b/README_ES.md new file mode 100644 index 0000000..3dc9c26 --- /dev/null +++ b/README_ES.md @@ -0,0 +1,85 @@ +# Descripción +Repositorio acerca de cómo hacer una lista de TO-DO en markdown. + +# Contenido ES +- [Estructura de los directorios](#Estructura-de-los-directorios) +- [¿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) + +## Estructura de los directorios +```txt +. +├── README.md +├── LICENSE +└── Examples_TODO + └── TODO.md + └── TODO2.md + └── TODO3.md + └── TODO[..].md +``` +## ¿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) +- [Extensión de Vscode: Kanban](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) +- [README EN](README.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..b09ba38 --- /dev/null +++ b/TODO_examples/TODO2.md @@ -0,0 +1,30 @@ +# 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) \ No newline at end of file From 97068833096957a8d070f191487533b1445396d9 Mon Sep 17 00:00:00 2001 From: Valentina Date: Mon, 10 May 2021 10:36:04 -0300 Subject: [PATCH 3/5] Syntax --- Examples_TODO/TODO.md | 19 ------------------- Examples_TODO/TODO2.md | 20 -------------------- README.md | 2 +- 3 files changed, 1 insertion(+), 40 deletions(-) delete mode 100644 Examples_TODO/TODO.md delete mode 100644 Examples_TODO/TODO2.md diff --git a/Examples_TODO/TODO.md b/Examples_TODO/TODO.md deleted file mode 100644 index ef8b273..0000000 --- a/Examples_TODO/TODO.md +++ /dev/null @@ -1,19 +0,0 @@ -# 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/Examples_TODO/TODO2.md b/Examples_TODO/TODO2.md deleted file mode 100644 index cb87110..0000000 --- a/Examples_TODO/TODO2.md +++ /dev/null @@ -1,20 +0,0 @@ -# My contribution on TODO.md (@shirosweets) - -### Todo - -- [ ] \(Optional) Add autor -- [ ] Add contributors - -### In progress -- [ ] \(Optional) Add dynamic contributions - -### Follow up - -- [ ] Accept PR - -### Done ✓ - -- [x] Fork repositorie -- [x] Create [TODO2.md](Examples_TODO/TODO2.md) -- [x] Add commits -- [x] Push my commits to Github repository diff --git a/README.md b/README.md index 95ab68e..ace1345 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Repositorie about how to do TO-DO list on markdown. - [Structure of directories](#Structure-of-directories) - [What is TODO.md?](#What-is-`TODO.md`?) - [Why keep a TODO.md?](#Why-keep-a-`TODO.md`?) -- [Why not using online management tools?](#Why-not-using-online-management-tools?) +- [Why are we not using online management tools?](#Why-not-using-online-management-tools?) - [TODO.md format](#`TODO.md`-format) - [Examples](#examples) - [See also](#See-also) From c6c180ca6d05565d8259e5e61646d756b06e550a Mon Sep 17 00:00:00 2001 From: Valentina Date: Mon, 10 May 2021 10:38:10 -0300 Subject: [PATCH 4/5] Table of content: link --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ace1345..32c7afd 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ Repositorie about how to do TO-DO list on markdown. - [Structure of directories](#Structure-of-directories) - [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-not-using-online-management-tools?) +- [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) From 2fc51b55c0f9796bea369c4f3c3f7c58438a2dc4 Mon Sep 17 00:00:00 2001 From: Valentina Date: Tue, 11 May 2021 09:38:18 -0300 Subject: [PATCH 5/5] Added new changes --- README.md | 18 +----------------- README_ES.md | 15 +-------------- TODO_examples/TODO2.md | 3 ++- 3 files changed, 4 insertions(+), 32 deletions(-) diff --git a/README.md b/README.md index 32c7afd..1f8ad35 100644 --- a/README.md +++ b/README.md @@ -1,29 +1,14 @@ # Description -Repositorie about how to do TO-DO list on markdown. +Repository about how to create a TODO list using markdown. # Content EN -- [Structure of directories](#Structure-of-directories) - [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) - - ---- -## Structure of directories -```txt -. -├── README.md -├── LICENSE -└── Examples_TODO - └── TODO.md - └── TODO2.md - └── TODO3.md - └── TODO[..].md -``` - ## 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). @@ -84,5 +69,4 @@ Project Description ## See also - [Vscode Kanban Board Extension](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) -- [Vscode Kanban Extension](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) - [README_ES](README_ES.md) \ No newline at end of file diff --git a/README_ES.md b/README_ES.md index 3dc9c26..9024f62 100644 --- a/README_ES.md +++ b/README_ES.md @@ -2,25 +2,13 @@ Repositorio acerca de cómo hacer una lista de TO-DO en markdown. # Contenido ES -- [Estructura de los directorios](#Estructura-de-los-directorios) - [¿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) - -## Estructura de los directorios -```txt -. -├── README.md -├── LICENSE -└── Examples_TODO - └── TODO.md - └── TODO2.md - └── TODO3.md - └── TODO[..].md -``` +--- ## ¿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). @@ -81,5 +69,4 @@ Descripción del proyecto ## Ver también - [Extensión de Vscode: Kanban Board](https://marketplace.visualstudio.com/items?itemName=coddx.coddx-alpha&ssr=false) -- [Extensión de Vscode: Kanban](https://marketplace.visualstudio.com/items?itemName=mkloubert.vscode-kanban) - [README EN](README.md) \ No newline at end of file diff --git a/TODO_examples/TODO2.md b/TODO_examples/TODO2.md index b09ba38..b15fb98 100644 --- a/TODO_examples/TODO2.md +++ b/TODO_examples/TODO2.md @@ -27,4 +27,5 @@ Use **P0**, **P1**, **P2**, **P3** at the end for priorities. Optional items can - [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) \ No newline at end of file + - [x] Use **P3** to Optional (P2) + - [x] Change description (P2) \ No newline at end of file