LinuxGSM_ Dev
  • Home
  • Getting Started
    • Getting Started
    • Programming Language
    • Development Software
    • Test Environment
    • Developer Commands
    • Adding a new Game Server
  • Workflow
    • Semantic Versioning
    • Workflow
    • Agile
    • Pull Requests
    • Gitflow
    • Conventional Commits
    • Unit Tests
  • Technical
    • Main Executable
    • Commands
    • Exit Codes
    • Functions
    • Modules
      • Fixes
      • Core
    • Game Server Querying
    • Messages & Logs
    • Checks
    • Exit
    • Install
    • Debuggins
  • Code Standards
    • Style Guide
    • Shellcheck Linter
    • Text Editor Settings
Powered by GitBook
On this page
  • Intro
  • Choosing an Issue to Develop
  • Starting Development

Was this helpful?

  1. Getting Started

Getting Started

PreviousHomeNextProgramming Language

Last updated 1 year ago

Was this helpful?

Intro

This guide will give a brief overview of how to get started developing LinuxGSM by running through some of the basics of using GitHub and the tools you need. This is not a comprehensive guide to GitHub but should help with getting started. There are plenty of resources available online such as the and that will help you learn more.

Choosing an Issue to Develop

When reviewing an issue it is a good idea to look at factors such as complexity, scope, and time to develop.

It is recommended that a simple issue is picked first as they are more likley to be merged quickly.

Starting Development

Whenever someone raises a new feature request or bug is done on the page. There is a raft of issues with different levels of complexity. Choosing an issue to work on is down to you as an individual, however, it is important you enjoy working on it.

Popular issues to attempt are as often developers want to have a game server added to the project. Be warned however some game servers can be more difficult than others to develop.

To help filter issues GitHub uses to help identify the types of issues. Common labels include type:bug, type:feature, command:monitor, game: 7 Days to Die. Labels are split into label types such as type, command, game, and info to aid in prioritising and managing them.

To begin working on LinuxGSM you need to the LinuxGSM repository once forked you will need to your new repository to your local machine using your chosen git client. Once cloned it is possible to edit the code on your local machine using your text editor of choice.

It is recommended you create a to develop your code. The branch should use the Gitflow methodology and should be named feature/[featurename].

Once a change has been made and saved the change will need to be committed to your local repo. When using commit it is important to leave a useful message to describe the change, this is covered in . When you are ready to send your commits to your remote fork you will need to the updates.

GitHub Issues
type:Server Requests
labels
fork
clone
branch
Conventional Commits
push
GitHub help documentation
guides