QGreenland Researcher Workshop 2023
Git is the “foundation” of GitHub; it is an information (not code!) management system. Git can answer questions like:
GitHub is a hosting service for Git repositories with lots of extra bells and whistles. GitHub has competitors like GitLab and BitBucket which offer similar features, like:
To “save” the file, we have to click “Commit new file”. It’s helpful to write a change description, but in this case the default (Create README.md
) is already descriptive enough.
Commit new file to the repository
I made a mistake: I wanted the “Authors” to be on a separate line from “Selected dataset”.
README doesn’t look quite right, let’s edit it
I need to add a blank line between paragraphs, or Markdown will see them as a single paragraph:
README in the GitHub editor
This time, I’ll check my work:
Use the preview feature to validate this time
Now it’s time for a descriptive “commit message”!
Commit changes
Download a notebook from JupyterLab
After selecting “Upload files”, you will be given the opportunity to browser your computer or drag-and-drop files into GitHub.
After selecting “commit” on the previous page, your files are visible in the repository!
When you click to open your notebook, GitHub will display a rich preview!
View the notebook in GitHub
You can view the full provenance of your repository by selecting the “Commits” button.
Navigate to the commits view
Our commit messages tell a story about the history of the repository.
Commits are listed with newest at the top
Scroll down until you see the “Features” section. From there, you can enable “Discussions”, “Issues”, and many other helpful features.
GitHub Repository > Settings > Features
Navigate to Zenodo’s GitHub settings
Note: You may need to configure your organization to enable third-party application access.
Enable the repository in Zenodo
Create a new release on GitHub
A tag is a unique string that we will use to identify the new release. GitHub makes useful suggestions on this page. A good first tag is v0.1.0
.
Useful suggestions from GitHub on the right sidebar
Our first release
Our DOI in Zenodo! Click here to get a badge for our repo and copy the Markdown.
Paste the Markdown in our README.md file
Commit the change to the main
branch
Our badge is looking fresh!
CITATION.cff
file to the repository to help Zenodo generate a better citation.CHANGELOG.md
file and update it with every release.💪 Working with a GitHub repository