Add versionning to our conventions

[benoit74]

It begins to be hard for me to know which conventions of this bootstrap have been deployed to which scraper. And as time goes by, it will only become harder.

I think it is time to begin to version these conventions.

I don't know how to do it properly, since:

• the CHANGELOG.md and README.md are more linked to the demo great_project than to the conventions
• the conventions are a mix of pure code and some wiki pages (but most conventions are in the code)

I wonder if we should:

• move great_project to a subdirectory and hence create a CHANGELOG and a README on root folder more dedicated to explain what the repo is about
• move all wiki pages to the code repo so that they are versioned together with the code base and reviewed as well in PRs (and easier to find)

WDYT?

[rgaudin]

You forgot the most important: how to include the bootstrap version into the final project? I suppose a metadata in the pyproject.yml

I'm for keeping the structure as it is but moving wiki pages into a docs/ folder. I'm not sure those are much tied to a version and I prefer the Wiki UI as a reader but the fact that we're not notified on changes and we can't PR is a real bummer.

[benoit74]

I'm ok with your suggestions.

I have no experience on pyproject additional metadata, where would it be?

Where do you suggest to put the CHANGELOG? "Abuse" the one of great_project? Or add an additional one in docs/?

[rgaudin]

Maybe that docs folder is named bootstrap/ instead and we can safely have the README, CHANGELOG and the docs ; WDYT?

[benoit74]

docs/ was fine for me (and clearer from my PoV)

[rgaudin]

I'm fine with both