Skip to content

Commit

Permalink
Merge pull request #17 from statisticsnorway/dev_bidra
Browse files Browse the repository at this point in the history
Dev bidra
  • Loading branch information
sjentoft authored Nov 8, 2023
2 parents 3122798 + 6f11c94 commit 8761f4f
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/workflows/publish.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,6 @@ jobs:
uses: quarto-dev/quarto-actions/publish@v2
with:
target: gh-pages
path: website
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,13 @@ statistikkproduksjonen](https://www.ssb.no/teknologi-og-innovasjon/artikler-og-p
| maskinlæring | |
| konfidensialitet | undertrykking <br> avrunding <br> støylegging |

## Legg inn en ny funksjon

Har du en metodiske funksjon som du mener bør ligge inn i Metodebiblioteket? Her finne du [instruks om hvordan å legge inn en ny funkjson](https://github.com/statisticsnorway/metodebiblioteket/blob/master/bidra.md). Husk at et av kravene er at funksjoner brukes i minst et produksjonsløp eller i et av SSBs metode-kursene. Funksjoner kan være i R eller python.


## Status

Status på Metodebiblioteket ligger på [status siden](https://github.com/statisticsnorway/metodebiblioteket/blob/master/status.md)


19 changes: 19 additions & 0 deletions bidra.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# Veiledning i hvordan å legge en funksjon inn i Metodebiblioteket
Her finner du veiledning om hvordan du kan bidra til Metodebiblioteket med en funksjon.

1. **Clone repository og lage en ny branch**:
Clone repository fra [github](https://github.com/statisticsnorway/metodebiblioteket). Dette kan du gjøre fra terminalet eller fra inn i RStudio for eksempel. Lage en ny branch for endringer.

2. **Legg funksjonen inn i create_table.R**:
Åpne filen som ligger under "internal" som heter "create_table.R". Legg inn en ny rad med funksjonen "add_func()". Skriv navn av funksjonen, pakkenavn og stikkord. Standard stikkord som skal brukkes ligger på [Readme filen til repository](https://github.com/statisticsnorway/metodebiblioteket/blob/master/README.md#n%C3%B8kkelord). Skriv gjerne inn (GSBPM) prosessnummer i stikkord også. Kjør den nye raden du har skrevet slik at datafil som ligger bak oppdateres.

3. **Legg pakken som brukes inn i DESCRIPTION fil**:
Hvis du har lagt inn en ny R funksjon skal pakken også ligge i DESCRIPTION filen under imports. Dette er for at Metodebiblioteket skal også fungere som en metapakke. Hvis pakken ligger der fra før er det ikke nødvendig å legge det inn på nytt.


4. **Skriv en enhetstest til funksjonen**:
For å forsikre kvalitet til funksjonene vi inkluderer i Metodebiblioteket har vi et mål at alle funksjoner skal har minst en enhetstest. Disse testene kjøres automatisk ved endring til hoved branch for å sjekke at funksjoner fungere som de skal. For mer informasjon om enhetstest skriving se [Hadley Wickhams veiledning til testthat](https://r-pkgs.org/testing-basics.html) for R eller [veiledning til pytest](https://docs.pytest.org/en/7.4.x/getting-started.html) for python. Enhetstester i R skal ligge under mappen tests > testthat. Python enhetstester skal ligge under python > tests.

5. **Commit og push endringer til github**:
Commit og push endringer til github. Alle endringer til create_table.R filen, data filen ("katalogdata.csv"), hjelpefiler (DESCRIPTION og reexports.R), og enhetstester skal inkluderes. Til slutt, lage en pull request for å merge branch inn til hovedbranch som da starter oppdatering av nettsiden automatisk.

0 comments on commit 8761f4f

Please sign in to comment.