Skip to content

Update CONTRIBUTING.md hoofdstuknummers #173

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
joost-vanoverbeke merged 1 commit into from
Apr 22, 2026
Merged

Update CONTRIBUTING.md hoofdstuknummers #173

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 10 additions & 31 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- working in Rstudio : <https://inbo.github.io/git-course/workflow_rstudio.html>
- collaboration : <https://inbo.github.io/git-course/workflow_review.html>

# Update/add local 'moneos' folder on your pc
# 1. Update/add local 'moneos' folder on your pc

## Case 1: you already have a local (git) folder 'moneos' on your computer

Expand All @@ -29,7 +29,7 @@

![image](https://user-images.githubusercontent.com/45075881/170995002-4847b3b7-d0c6-4aef-93c4-48b9470b032d.png)

# Open and setup the moneos project for the current year in Rstudio
# 2. Open and setup the moneos project for the current year in Rstudio

- select 'file' -\> 'open project'
- under the moneos folder, browse to the subfolder for the year of reporting (folder 'moneos_XXX' where XXX is the current year)
Expand All @@ -52,7 +52,7 @@
- copy the file '\_.Renviron' to the folder 'moneos/moneos_XXX'
- rename the '\_.Renviron' under 'moneos/moneos_XXX' to '.Renviron' (remove the underscore '\_')
- in a text editor or in Rstudio, open the '.Renviron' file and adjust the folder paths to the paths used on your local pc
- if you are already working in Rstudio, close Rstudio and reopen it
- **Close Rstudio** and reopen it

## update the 'main' branch from github

Expand All @@ -62,7 +62,7 @@

- `pull` ![image](https://user-images.githubusercontent.com/45075881/231096746-42c55df8-61b7-4a54-86c8-9561f2158553.png) the latest version of 'main' from github.

# Moneos chapter branch
# 3. Moneos chapter branch

- For each chapter in the moneos report use a separate branch to work in.
- In doing so you can work independently of other chapters and avoid interference between work done on different chapters.
Expand Down Expand Up @@ -98,7 +98,7 @@

<img src="https://user-images.githubusercontent.com/45075881/230026926-905f1b81-51c3-452a-8c35-64dd1ca6fa61.png" alt="image" width="400"/>

# Setup chapter R(md) files
# 4. Setup chapter R(md) files

- While being in your chapter branch:
- Under the folder 'moneos/moneos_XXXcurrentYearXXX' create a subfolder for your chapter with the same name as the chapter.
Expand Down Expand Up @@ -133,7 +133,7 @@

- follow the guidelines as above but use the template files in the folder 'moneos/moneos_XXXcurrentYearXXX/000_template' as a starting point.

# Working on a chapter
# 5. Working on a chapter

- The following applies both for data analysis as for writing the report.
- Make sure to be in the git branch for the chapter you want to work on.
Expand All @@ -157,7 +157,7 @@

- You can subsequently `push` ![image](https://user-images.githubusercontent.com/45075881/231096204-e9a59481-4790-4b8f-9545-3a9132750d23.png) the changes to github from the commit window or from the main github sidepanel.

# Working in `Visual` mode
# 6. Working in `Visual` mode

- To write the chapter report, it can be useful to use the `Visual` mode in the RStudio editing panel.

Expand Down Expand Up @@ -185,7 +185,7 @@

![image](https://user-images.githubusercontent.com/45075881/231726186-2f240adc-ce20-47ea-badd-ac210f3aad2b.png)

# Building the report pdf
# 7. Building the report pdf

- To build the report, go to the tab 'Build'.
- Make sure the 'pdf_report' is selected under 'build book'.
Expand All @@ -206,28 +206,7 @@

- Don't use underscore '\_' in column names of tables.

# Merging your branch with the main branch (pull request)

- make sure you merged the latest version of the main branch (potentially comprising already merged chapters) into your chapter branch before you make a pull request
- to merge the latest version of the main branch
- see <https://inbo.github.io/git-course/workflow_review.html#Merge_changes_to_main>
- switch to the 'main' branch in Rstudio
- hit the `pull` button ![image](https://user-images.githubusercontent.com/45075881/231096746-42c55df8-61b7-4a54-86c8-9561f2158553.png)
- switch back to your chapter branch
- open the (Git) terminal and enter the command: 'git merge main'

![image](https://github.com/inbo/moneos/assets/45075881/185e1df6-6e21-4e23-b056-e04ff6472b66)

![image](https://github.com/inbo/moneos/assets/45075881/d9bae55c-098c-45a0-ba1e-77d6cfa6d5f7)

- create a pull request as explained in <https://inbo.github.io/git-course/workflow_review.html#Create_a_pull_request>
- a reviewer is mandatory to make a pull request; choose Joost Vanoverbeke as reviewer
- some checks are performed when you make a pull request. This may take a little time to finish

![image](https://user-images.githubusercontent.com/45075881/171813020-738149a3-cb49-4e66-818d-77979a42e415.png)\
![image](https://user-images.githubusercontent.com/45075881/171812792-974b89a7-fa56-48cf-ab1b-2a7b41b1494c.png)

# Reviewing
# 8. Reviewing

## Reviewing a chapter

Expand Down Expand Up @@ -286,7 +265,7 @@

- after checking and further editing the reviewed chapter, follow the instructions to commit and push your changes to github

# Avoiding GIT conflicts
# 9. Avoiding GIT conflicts

- In the first phase, only work in your own branch and on your own chapter (chapter directory and chapter `.Rmd` files)
- if contribution to another chapter is needed
Expand Down
Loading