If you're writing a research paper in computer science or another technical discipline, you may want to include source code in your research sources, such as code you find in a GitHub repository. Generally, you should include enough information in your list of references at the end of your paper to enable your reader to locate the code and review it for themselves. However, the specific format of your citation will vary depending on which citation guide you use. In the computer sciences, Institute of Electrical and Electronics Engineers (IEEE), Association for Computing Machinery (ACM), and Council of Science Editors (CSE) citation styles are most commonly used.
Steps
-
Start your entry with the name of the author of the code. If the author is an individual, type their last name, followed by a comma, then their first initial. Do not place a period after the initial. If the code is produced by a company or institution, use that name as the name of the author. [1] X Research source
- Example: Facebook
- If you're having a hard time finding the author of a GitHub repository, look on the copyright page. List the entity that owns the copyright as the author.
-
Provide the date the code was created. Place the date in parentheses after the name of the author. Do not place any punctuation after the closing parenthesis. Use the copyright date if you can't find a specific date the code was created. [2] X Research source
- Example: Facebook (2020)
Advertisement -
Include the title of the program or source code and identify the type. Type the title of the program from the ReadMe file. Copy the capitalization used by the authors to identify the code, since it may have significance. Use the description "Source code" for a GitHub repository, enclosed in square brackets. Place a period after the closing square brackets. [3] X Research source
- Example: Facebook (2020) Recoil [Source code].
-
Close with the URL where the code can be found. For a GitHub repository, your URL will be the basic URL for the repository. Place a period at the end of the URL to close your entry. [4] X Research source
- Example: Facebook (2020) Recoil [Source code]. https://github.com/facebookexperimental/Recoil.
IEEE Reference List Format: AuthorLast, I (Year) Title of Code (Version #.#) [Source code]. URL.
-
Use a bracketed number to refer to the entry in your Reference List. In-text citations aren't necessary in IEEE style. Instead, refer to the source by a number in square brackets. You'll use the same number each time you reference that source in your paper. [5] X Research source
- When you create your Reference List, list the sources in the order they appear in your paper, using the same numbers that you used throughout your paper. It can help to keep a list of sources as you're writing, so you'll know which source is attached to which number.
-
Start your References entry with the name of the author. Type the name of the author of the code in first-name, last-name format. If the code or repository is owned by a company or institution, that company or institution is usually considered the author. [6] X Research source
- Example: Hoanh An.
-
Provide the year the repository was created. If you can't find an exact year the repository was created, use the copyright year instead. Type the year after the author, followed by a period. [7] X Research source
- Example: Hoanh An. 2019.
-
Add the title of the program. Type the title of the program in sentence case, capitalizing the first word and any proper nouns in the title. If there's a subtitle, place a colon after the title and type the subtitle in sentence case. Place a period at the end. [8] X Research source
- Example: Hoanh An. 2019. Ultimate Go study guide.
-
Close with the URL for the repository and the year you accessed it. Type the full URL for the repository, followed by a period. Then, add the year you accessed the repository in parentheses. Place a period outside the closing parenthesis. [9] X Research source
- Example: Hoanh An. 2019. Ultimate Go study guide. https://github.com/hoanhan101/ultimate-go. (2020).
ACM References Format:
AuthorFirst Author Last. Year. Title of program. URL. (AccessYear).
-
Use a number in square brackets for your in-text citations. ACM references are listed in the order they are cited in your paper. At the end of any sentence in which you reference the code, type a sequential number in square brackets. Use the same number for that source whenever you reference the same code. [10] X Research source
- If you reference multiple sources in the same sentence, include each of the numbers in the same set of square brackets, separated by commas.
-
Start your Bibliography entry with the name of the author. Type the last name of the author, followed by a comma, then the author's first initial. If you're having a hard time finding the author, look at the copyright page — the person or institution who owns the rights to the code is considered the author. [11] X Research source
- Example: Palmer, J.
-
Add the year of publication or release. The year of publication or release is typically also listed on the copyright page. Type the year after the name of the author, then place a period after the year. [12] X Research source
- Example: Palmer, J. 2017.
-
Include the title of the program or repository. Type the title in sentence case, capitalizing only the first word and any proper nouns. If the title has code in it, copy the capitalization used in the title. For a subtitle, place a colon after the title and then type the subtitle in sentence case. Placed a period at the end. [13] X Research source
- Example: Palmer, J. 2017. Formik: Build forms in React, without the tears.
-
Provide the location and name of the publisher. For a GitHub repository, GitHub, located in San Francisco, California, is considered the publisher. Type the city first with the state abbreviation "CA" in parentheses, followed by a colon. Then, type the name of the publisher, followed by a semi-colon. [14] X Research source
- Example: Palmer, J. 2017. Formik: Build forms in React, without the tears. San Francisco (CA): GitHub;
-
Close with your date of access and the URL. Inside square brackets, type the word "accessed" then add the date you last accessed the code in year-month-day format. Abbreviate all months to 3 letters. Place a period after the closing square bracket. Add the URL for the repository, then place a period at the end. [15] X Research source
- Example: Palmer, J. 2017. Formik: Build forms in React, without the tears. San Francisco (CA): GitHub; [accessed 2020 May 16]. https://github.com/jaredpalmer/formik.
CSE Bibliography Format:
Author A. Year. Title of program. San Francisco (CA): GitHub; [accessed Year Mon Day]. URL.
-
Cite your sources in-text following 1 of 3 in-text citation systems. While most style and format guides have a single preferred method of in-text citation, CSE has 3 that are equally acceptable. Which one you use depends on the requirements of your instructor or advisor, academic department, or publication. Your choices are: [16] X Research source
- Citation-name: Superscript numbers identify in-text citations. Each number corresponds to a reference in your alphabetized Bibliography at the end of your paper.
- Citation-sequence: Superscript numbers identify in-text citations. The Bibliography at the end of your paper is listed in the order the references appear as citations in your paper.
- Name-year: Use parenthetical in-text citations with the name of the author and the year the source was published. The Bibliography at the end of your paper is in alphabetical order.
Expert Q&A
Tips
References
- ↑ https://uark.libguides.com/CSCE/CitingCode
- ↑ https://uark.libguides.com/CSCE/CitingCode
- ↑ https://uark.libguides.com/CSCE/CitingCode
- ↑ https://uark.libguides.com/CSCE/CitingCode
- ↑ https://pitt.libguides.com/citationhelp/ieee
- ↑ https://www.acm.org/publications/authors/reference-formatting
- ↑ https://www.acm.org/publications/authors/reference-formatting
- ↑ https://www.acm.org/publications/authors/reference-formatting
- ↑ https://www.acm.org/publications/authors/reference-formatting
- ↑ https://www.acm.org/publications/authors/reference-formatting
- ↑ https://dal.ca.libguides.com/CitationStyleGuide/CSE
- ↑ https://guides.lib.uw.edu/ld.php?content_id=14048491
- ↑ https://guides.lib.uw.edu/ld.php?content_id=14048491
- ↑ https://guides.lib.uw.edu/ld.php?content_id=14048491
- ↑ https://dal.ca.libguides.com/CitationStyleGuide/CSE
- ↑ https://dal.ca.libguides.com/CitationStyleGuide/CSE