search

OpenRailAssociation / osrd-website

OSRD website (work in progress)
https://osrd.fr/
4 stars 12 forks source link

Reorganize whole contribution section in a clearier way #154

Closed nicolaswurtz closed 8 months ago

nicolaswurtz commented 10 months ago

Sorry for this big pull request, no choice: all contribution section has been reorganized. This is a proposal, I've put all items in a tutorial form like, step after step (with more links and more logic).

To review it you MUST see it in action with hugo, don't use only github.

:warning: On front-end conventions page, RTK section translation is missing. It was already missing before. Will be done later, lack of courage for now...

Thank you!

clarani commented 8 months ago

Also I would add a space above the title "Revue de code" image

nicolaswurtz commented 8 months ago

Also I would add a space above the title "Revue de code" image

Sorry, it's by design in docsy theme, we can't really change this on demand...

nicolaswurtz commented 8 months ago

Thanks for this PR 🙏 (suggestions on who resolves conversation is not mandatory IMO)

It's more clear to precise that the person who asks for a question is the one that closes the same question. I know that it could be more free, but in a practical way, we decided to write down this process, to harmonize every single task of the review process. It's not freezed in time, just for now. We'll see !

nicolaswurtz commented 8 months ago

I find the new organization better in general, even in term of maintenance for the website (more segmented). But I do have a few general remarks (apart from the minor typos here and there that I've found).

* Would we need an additional section on other type of contributions than code? I'm thinking: documentation, translation, bug triaging, whatever...

* I didn't find the separation between "write-code" and "commit-style" useful at first, especially since we speak about creating "commit" in "write-code". But maybe just a mention and link from "write-code" to "commit-style" would be sufficient 🤔

Nothing is blocking from merging this PR which is already an improvement (even the typos, I believe some of them were already there before). 👏

I agree with you about commit link, that's why I already putted a link to commit style at the bottom of the page ;)