3 måder at angive et GitHub -lager

Indholdsfortegnelse:

3 måder at angive et GitHub -lager
3 måder at angive et GitHub -lager

Video: 3 måder at angive et GitHub -lager

Video: 3 måder at angive et GitHub -lager
Video: Sådan laver man FAKE BRÆK! | Akavet 2024, Marts
Anonim

Hvis du skriver et forskningspapir inden for datalogi eller en anden teknisk disciplin, kan du medtage kildekode i dine forskningskilder, f.eks. Kode, du finder i et GitHub -depot. Generelt bør du inkludere tilstrækkelig information på din referenceliste i slutningen af dit papir til, at din læser kan finde koden og gennemgå den selv. Det specifikke format på dit citat vil imidlertid variere afhængigt af, hvilken citationsguide du bruger. Inden for datalogi bruges oftest citatformater fra Institute of Electrical and Electronics Engineers (IEEE), Association for Computing Machinery (ACM) og Council of Science Editors (CSE).

Trin

Metode 1 af 3: IEEE

Nævn et GitHub -arkiv Trin 1
Nævn et GitHub -arkiv Trin 1

Trin 1. Start din indtastning med navnet på forfatteren af koden

Hvis forfatteren er en person, skal du skrive deres efternavn efterfulgt af et komma og derefter deres første initial. Placer ikke en periode efter initialen. Hvis koden er produceret af en virksomhed eller institution, skal du bruge dette navn som forfatterens navn.

  • Eksempel: Facebook
  • Hvis du har svært ved at finde forfatteren til et GitHub -arkiv, skal du se på ophavsretssiden. Angiv den enhed, der ejer ophavsretten som forfatteren.
Nævne et GitHub -arkiv Trin 2
Nævne et GitHub -arkiv Trin 2

Trin 2. Angiv den dato, hvor koden blev oprettet

Placer datoen i parentes efter forfatterens navn. Placer ikke nogen tegnsætning efter den afsluttende parentes. Brug ophavsretsdatoen, hvis du ikke kan finde en bestemt dato, hvor koden blev oprettet.

Eksempel: Facebook (2020)

Nævn et GitHub -arkiv Trin 3
Nævn et GitHub -arkiv Trin 3

Trin 3. Medtag titlen på programmet eller kildekoden, og identificer typen

Indtast programmets titel fra ReadMe -filen. Kopier den store bogstav, som forfatterne brugte til at identificere koden, da den kan have betydning. Brug beskrivelsen "Kildekode" til et GitHub -depot, der er omsluttet af firkantede parenteser. Placer en periode efter de lukkende firkantede parenteser.

Eksempel: Facebook (2020) Rekyl [Kildekode]

Nævn et GitHub -arkiv Trin 4
Nævn et GitHub -arkiv Trin 4

Trin 4. Luk med den URL, hvor koden kan findes

For et GitHub -lager er din URL den grundlæggende webadresse til depotet. Placer en periode i slutningen af webadressen for at lukke din post.

Eksempel: Facebook (2020) Rekyl [Kildekode]

IEEE Reference List Format:

Forfatter Sidste, I (År) Kodebetegnelse (Version #. #) [Kildekode]. URL.

Nævn et GitHub -arkiv Trin 5
Nævn et GitHub -arkiv Trin 5

Trin 5. Brug et parentes nummer til at henvise til posten i din referenceliste

Citater i teksten er ikke nødvendige i IEEE-stil. Henvis i stedet til kilden med et tal i firkantede parenteser. Du bruger det samme nummer, hver gang du refererer til den kilde i dit papir.

Når du opretter din referenceliste, skal du angive kilderne i den rækkefølge, de vises i dit papir, ved hjælp af de samme numre, som du brugte i hele dit papir. Det kan hjælpe med at holde en liste over kilder, mens du skriver, så du ved, hvilken kilde der er knyttet til hvilket nummer

Metode 2 af 3: ACM

Nævn et GitHub -arkiv Trin 6
Nævn et GitHub -arkiv Trin 6

Trin 1. Start din referencepost med forfatterens navn

Skriv navnet på forfatteren af koden i fornavn, efternavn. Hvis koden eller depotet ejes af en virksomhed eller institution, betragtes denne virksomhed eller institution normalt som forfatteren.

Eksempel: Hoanh An

Nævn et GitHub -arkiv Trin 7
Nævn et GitHub -arkiv Trin 7

Trin 2. Angiv det år, hvor depotet blev oprettet

Hvis du ikke kan finde et præcist år, hvor depotet blev oprettet, skal du bruge ophavsretsåret i stedet. Skriv året efter forfatteren efterfulgt af en periode.

Eksempel: Hoanh An. 2019

Nævn et GitHub -arkiv Trin 8
Nævn et GitHub -arkiv Trin 8

Trin 3. Tilføj titlen på programmet

Indtast programmets titel i sætningssag, med store bogstaver i det første ord og eventuelle navneord i titlen. Hvis der er en undertekst, skal du placere et kolon efter titlen og skrive underteksten i sætningssag. Placer en periode til sidst.

Eksempel: Hoanh An. 2019. Ultimate Go studievejledning

Nævn et GitHub -arkiv Trin 9
Nævn et GitHub -arkiv Trin 9

Trin 4. Luk med URL'en til depotet og det år, du fik adgang til det

Indtast hele webadressen til depotet efterfulgt af en periode. Tilføj derefter det år, du fik adgang til depotet i parentes. Placer en periode uden for parentesen.

Eksempel: Hoanh An. 2019. Ultimate Go studievejledning. https://github.com/hoanhan101/ultimate-go. (2020)

ACM Referencer Format:

Forfatter Første forfatter Sidst. År. Programtitel. URL. (AccessYear).

Nævn et GitHub -arkiv Trin 10
Nævn et GitHub -arkiv Trin 10

Trin 5. Brug et tal i parenteser til dine tekster

ACM -referencer er angivet i den rækkefølge, de er anført i dit papir. I slutningen af enhver sætning, hvor du refererer til koden, skal du indtaste et rækkefølge i firkantede parenteser. Brug det samme nummer til den kilde, når du refererer til den samme kode.

Hvis du refererer til flere kilder i den samme sætning, skal du inkludere hvert af tallene i det samme sæt firkantede parenteser adskilt af kommaer

Metode 3 af 3: CSE

Nævn et GitHub -arkiv Trin 11
Nævn et GitHub -arkiv Trin 11

Trin 1. Start din bibliografi -post med forfatterens navn

Indtast forfatterens efternavn efterfulgt af et komma, derefter forfatterens første initial. Hvis du har svært ved at finde forfatteren, skal du se på ophavsretssiden - den person eller institution, der ejer rettighederne til koden, betragtes som forfatteren.

Eksempel: Palmer, J

Nævn et GitHub -depot Trin 12
Nævn et GitHub -depot Trin 12

Trin 2. Tilføj året for udgivelse eller udgivelse

År for udgivelse eller udgivelse er typisk også angivet på ophavsretssiden. Indtast året efter forfatterens navn, og anbring derefter en periode efter året.

Eksempel: Palmer, J. 2017

Nævn et GitHub -arkiv Trin 13
Nævn et GitHub -arkiv Trin 13

Trin 3. Medtag titlen på programmet eller lageret

Indtast titlen i sætningssag, og brug kun det første ord med eventuelle substantiver. Hvis titlen har kode, skal du kopiere den store bogstav, der bruges i titlen. For en undertekst skal du placere et kolon efter titlen og derefter skrive underteksten i sætningssag. Placerede en periode til sidst.

Eksempel: Palmer, J. 2017. Formik: Byg former i React, uden tårer

Nævn et GitHub -arkiv Trin 14
Nævn et GitHub -arkiv Trin 14

Trin 4. Angiv placeringen og navnet på udgiveren

For et GitHub -depot betragtes GitHub, der ligger i San Francisco, Californien, som udgiver. Skriv byen først med statsforkortelsen "CA" i parentes, efterfulgt af et kolon. Skriv derefter navnet på udgiveren efterfulgt af et semikolon.

Eksempel: Palmer, J. 2017. Formik: Byg former i React, uden tårer. San Francisco (CA): GitHub;

Nævn et GitHub -arkiv Trin 15
Nævn et GitHub -arkiv Trin 15

Trin 5. Luk med din adgangsdato og webadressen

I firkantede parenteser skal du skrive ordet "adgang" og derefter tilføje den dato, du senest fik adgang til koden i år-måned-dag-format. Forkort alle måneder til 3 bogstaver. Placer en periode efter den afsluttende firkantbeslag. Tilføj URL'en til depotet, og placer derefter en periode i slutningen.

Eksempel: Palmer, J. 2017. Formik: Byg former i React, uden tårer. San Francisco (CA): GitHub; [adgang til 2020 16. maj]

CSE bibliografi Format:

Forfatter A. År. Programtitel. San Francisco (CA): GitHub; [åbnet år mandag]. URL.

Nævn et GitHub -arkiv Trin 16
Nævn et GitHub -arkiv Trin 16

Trin 6. Nævn dine kilder i teksten efter 1 af 3 citatsystemer i teksten

Selvom de fleste typografi- og formatguider har en enkelt foretrukken metode til henvisning i tekst, har CSE 3, der er lige acceptable. Hvilken en du bruger, afhænger af kravene fra din instruktør eller rådgiver, akademiske afdeling eller publikation. Dine valg er:

  • Citation-name: Superscript numbers identificere in-text citations. Hvert nummer svarer til en reference i din alfabetiserede bibliografi i slutningen af dit papir.
  • Citationssekvens: Overskriftsnumre identificerer citater i teksten. Bibliografien i slutningen af dit papir er angivet i den rækkefølge, referencerne vises som citater i dit papir.
  • Navnår: Brug parenteser i tekst-citater med forfatterens navn og det år, kilden blev offentliggjort. Bibliografien i slutningen af dit papir er i alfabetisk rækkefølge.

Anbefalede: