Skip to content

Github Basics

Steven Clontz edited this page Jul 22, 2024 · 8 revisions

To use GitHub to contribute to this project, first log into your account or create a free account.


Main page

The main page of the repository is the same as the 'Code' tab at the top. You can navigate the file structure of the repository from this page if you need to look at the source code.

image

Issues

The next tab over is Issues. Note how the issues have different tags. The numbers on the right indicate how many comments have been made on that issue.

image

To create a new issue, hit the green "New Issue" button in the top right. Enter a title, and describe the issue. If you know who should implement this, you can assign it to them on the right. You can also add appropriate labels; at a minimum, please add the label for the appropriate book. Then hit the green "Submit new issue" button.

image

Once an issue is created, you can add comments to discuss the issue. You'll also see references to other activity on Github, for example if a commit or pull request is made that addresses the issue.

image

Discussions

The discussion page is a forum-like (or bulletin board-like) environment which is geared towards discussing potential directions, whereas issues are for specific suggestions or corrections. If you are unsure if something is a discussion or issue, note that it is possible to turn discussions into issues and vice versa, so just pick one to start.

image

Wiki

Finally, the last important page for most contributors is the Wiki page--that's what you are reading right now!

image

Clone this wiki locally