ResearchCodeReviewCommunity / dev-review

website with resources for researchers learning about code review during development
https://dev-review.readthedocs.io/en/latest/
5 stars 3 forks source link

Draft outline of process below flowchart #37

Closed tlestang closed 2 years ago

tlestang commented 3 years ago

This adds four subsections below the flowchart, proving an outline for the overall code review process.

The idea is that people landing on this page can quickly find out what we mean by code review - by both looking at the flowchart and reading the outline.

NickleDave commented 3 years ago

Overall this looks great and I think we should just merge in and tweak later

One possible suggestion: do we want flowchart shapes to link to headlines?

Like this:

# Title

## section1

text inside section 1

## section2 

text inside section

graph LR;
    A-->B;
    click A "./#section1"

(from https://stackoverflow.com/questions/60195408/is-there-a-way-to-put-urls-in-the-same-document-using-mermaid-markdown-flowchart)

NickleDave commented 3 years ago

@bielsnohr since you just said at the meeting you will review this we will wait until you do so but barring that, we were feeling like we should go ahead and merge in

bielsnohr commented 2 years ago

Overall this looks great and I think we should just merge in and tweak later

One possible suggestion: do we want flowchart shapes to link to headlines?

Yes, good suggestion @NickleDave and I think we should certainly do this. Might be best in a separate PR?