hw2b.md

---

 home :: syllabus :: timetable :: groups :: moodle :: video :: © 2021

---

Howework: 2b: Write a "good" Github Repo

Your repo is your resume. But what is a good looking repo?

Write a repo

With the structure shown below. Ensure that everyone in the group do at least one commit to the repo

Note:

• There is a lot to do here in a week .
• You'll probably only get bits of this going in 1 week. But keep at it. Remember that homeworks can be submitted many times with no penalties
• Suggestion: Divide up the structure between your group and everyone do different parts. But make sure everyone knows what each part is.

Submit your a URL to your repo to Moodle.

Structure

.gitignore
.travis.yml
CITATION.md : fill on once you've got your ZENODO DOI going
CODE-OF-CONDUCT.md
CONTRIBUTING.md
INSTALL.md
LICENSE.md
README.md
setup.py         // may change per language; e.g. Makefile 
requirements.txt // may change per language; e.g javascript uses package.json
data/
  README.md
test/
  README.md
code/
  __init__.py  // may change per language; 

If you don't know what any of the above do, then google them (they are quite standard). ALso, read the following:

• README.md
  • add the badge "build:passing" to your README.md.
    • Consider using a free service like github-actions
    • instructions
    • example
    • badging
    • Consider using travis-ci see Instructions
  • add the Zenodo DOI badge to your README.md. See Instructions
• .gitignore
• LICENSE.md
  • see here
  • and Choose a License
• CODE_OF_CONDUCT.md
• CONTRIBUTING.md
  • This contrib file is too verbose. Discuss with your group which 10-20 items you'd actually endorse from your project.
• requirements.txt
• setup.py, init.py
  • Test your package (python3 setup.py install)

Regarding the last point, keep it real simple. In Python, write the smallest example of pytest running a file containing some test_ functions.

# content of __init__.py
def inc(x):
    return x + 1

def test_answer():
    assert inc(3) == 5

Hook that code into your repo so that the "build:passing" badge wrosk ( so that everytime you commit your repo, your tests re-run).