Disgo Contribution Guide

[switchupcb]

This thread contains information relevant to contributing to Disgo.

Contact a maintainer if you need help at any point in this process.

[switchupcb]

This guide assumes that you are able to solve an easy LeetCode programming problem in any programming language.

Documentation

Fundamentals

If this is your first programming project, read The SwitchUpCB Basics of Software Development (Free Mirror).

• Programming Languages are abstractions of bits (1s and 0s).
• Approach programming problems by planning them (in human language) then implementing them (in programming language).
• Files contain the code (which compile to bits) to execute a program on a computer.
  • Code is executed line by line.
  • In order to debug an error, find the file and respective line that the error originates from.
• Software Projects are composed of files with various architectures (organization).

An understanding of microservices is not required in order to contribute to this project.

Disgo

The above series provides the fundamentals you need to fully understand A Quick History on the Development of Disgo. This article explains the purpose of Disgo and how it works. It also describes the purpose of Dasgo and how those changes are pulled into Disgo. Once understood, read the Disgo README to get familiar with the Disgo API.

Go

If you are unfamiliar with Go, understand why Disgo uses Go by reading "Why Go?" Once understood, get familiar with the features of Go by completing the Go Dev Tour.

Programming

If you haven't already, become confident in solving programming problems — in any language — at the level of a LeetCode easy. Being able to solve problems at this level ensures that you maintain the problem solving skills necessary to make your first code contribution in Disgo.

[switchupcb]

Contribution

Communication

Read the Contributing document of Disgo for an overview of the repository. Once completed, claim a task from the Roadmap to start working on. It's recommended to claim an unclaimed example as your first task. However, you are free to claim any task that is listed. There is also no need to wait for a maintainer to approve your claim, but it may save you time from doing work that is already being completed.

Development Environment (From Scratch)

This following development environment setup is required (if you don't already have a preferred setup).

1. Install the latest Go programming language: https://go.dev/doc/install
2. Set up the text editor you will use to edit code. We recommend for beginners to start with Visual Code Studio.
   a. Install the Go extension.
   b. Install the Markdown extension.
3. Set up Git.
   a. If you haven't already, create a GitHub account for ease of communication. Do note that GitHub is not Git, but rather a host of it. For more information, watch What is Git?.
   b. It's recommended to install GitHub Desktop, which provides an easy to use User Interface for the Git software: https://desktop.github.com/
   c. From the GitHub Website Disgo Repository, create a fork of Disgo: https://github.com/switchupcb/disgo/fork.
   d. From the GitHub User Interface or Command Line Interface on your machine, clone the repository you just forked (at your username/disgo).

Star this repository to indicate interest in it!

Development Environment (Disgo)

This following development environment setup includes all the necessary tools to merge a pull request in Disgo.

1. Install the tools listed in the Contributing document.
   a. golangci-lint Tool: go install github.com/golangci/golangci-lint/cmd/golangci-lint@v1.46.2
2. Install the tools listed in _gen. This step is only required if you wish to run the generators. If you aren't a maintainer, it's recommended to SKIP THIS STEP.

Development

Create a Branch

It's recommended to create a branch that will be used for the feature that you plan to add (i.e example). Need help? Read Creating a Branch or use the Git CLI from your terminal.

Implement the Feature

Once your branch is created, commit at checkpoints during the implementation of your feature. A checkpoint is not an official term, but rather refers to changes in your code that are relevant to smaller scopes of your feature. For more information, read About Commits. For an example of commit messages, view the Disgo Commit History.

Pull Request

Once the feature is implemented (and committed), you must create a pull request for your branch to be merged into the main repository (this repository switchupcb/disgo) in a given branch (v10). For more information on branching and merging, watch Branching and Merging.

Once your branch has been pull requested, it will show up as an open pull request at https://github.com/switchupcb/disgo/pulls. You must wait for a maintainer to review your code, suggest changes, and/or merge the code into the repository. Once your code is merged, you have made a successful contribution to Disgo.