Skip to content

Commit

Permalink
docs: use project board (#17)
Browse files Browse the repository at this point in the history
* Delete TODO.md

* Update README.md

* Update CONTRIBUTING.md
  • Loading branch information
fabien-roy authored May 10, 2022
1 parent c465392 commit 7ede411
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 48 deletions.
12 changes: 4 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,18 @@

**Contributions are welcome!**

Don't forget to read the [docs](https://exilednarwal28.github.io/nuxt3-template)!
Don't forget to read the [docs](https://rock-n-prog.github.io/nuxt3-template)!

## Code of conduct

Before contributing to the project, please read our [code of conduct](CODE_OF_CONDUCT.md).

## Task tracking

Currently, we use a simple [TODO file](TODO.md) to track what should be implemented next. This is only because I'm working alone for now. Sooner or later, a GitHub project will be created and documented here.

**Mostly everything under "Task tracking" is false for now, because of the simple starting setup.**
Task tracking uses the [project board](https://github.com/orgs/Rock-n-Prog/projects/1).

### Functionnalities to implement

The backlog, functionnalities, user stories and use-cases to implement can be found in [this project's wiki](https://github.com/ExiledNarwal28/nuxt3-template/wiki). You will also find documentation and drafts for planned features.

### Issues

We track our issues with GitHub issues. Each issue must have at least one person assigned, an associated milestone and correct labels.
Expand All @@ -26,9 +22,9 @@ Milestones represent release versions. We use [Semanting Versioning 2.0.0](https

### Project board

Issues must be placed on the [project board](https://github.com/ExiledNarwal28/space-elevator/projects/1). There are 5 columns in this board :
Issues must be placed on the [project board](https://github.com/orgs/Rock-n-Prog/projects/1). There are 5 columns in this board :

- Maybe : Optionnal issues to improve the codebase but with no direct value to the main features
- To groom : Issues not yet marked as "To do"
- To do : Issues that must be done to deliver the current iteration
- In progress : Self-explanatory
- Under review : Issues currently in review or waiting to be merged
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Simple [Nuxt 3](https://v3.nuxtjs.org/) and [Apollo](https://www.apollographql.c

Made with love by [Fabien Roy](https://github.com/ExiledNarwal28).

Check [TODO.md](TODO.md) for what I want to do next.
Check the [project board](https://github.com/orgs/Rock-n-Prog/projects/1) for what I want to do next.

To contribute, make sure you have read the [docs](https://exilednarwal28.github.io/nuxt3-template) and [contribution guide](CONTRIBUTING.md).

Expand Down
39 changes: 0 additions & 39 deletions TODO.md

This file was deleted.

0 comments on commit 7ede411

Please sign in to comment.