Contents 1 GitHub Access 1.1 The Basics 1.1.1 Git/GitHub for Beginners 1.1.2 Forking MyBB 1.1.3 Configuration 1.1.4 Working on Windows

GitHub Access

Welcome to the Development GitHub Access page. This document describes how to access MyBB's projects and repositories hosted at GitHub and an example workflow for both Team Members and volunteers.

The Basics

While working with GitHub it is completely up to you as to what tools and software you use to help contribute to MyBB. If you're not confident with command line Git, GitHub provides and easy to use workspace with desktop software for Mac or Windows. This software helps you keep in sync with the development on all branches in the repository as well as your own projects. Where possible, we recommend using this software.

Git/GitHub For Beginners

If you haven't worked with MyBB, Git or GitHub before we recommend following GitHub's Bootcamp which will get you started with contributing to projects. The MyBB Team are not here to help you with problems with Git or GitHub; we do expect you to have a technological understanding of this process.

Forking MyBB

Once you are setup with GitHub, visit the MyBB Project on GitHub. MyBB 1.x is located within the mybb repository. Fork the repository; this creates your own copy for you to work on.

	$ git clone git://github.com/mybb/mybb.git

Our repository contains three main branches:

• Master
  Contains code that is publically released
• Stable
  Contains security and other maintenance work on existing minor-point releases (1.6.x)
• Feature
  Contains work on the next feature release or features that are to be implemented into a series (1.8.x)

Configuration

Before working on GitHub, be sure to add some important configuration data to your Git client.

• Username

  First, you need to tell Git your name so it can properly label the commits you make.

  	$ git config --global user.name "John Doe"

• Email

  Git saves your email address into the commits you make. GitHub uses the email address to associate your commits with your GitHub account.

  	$ git config --global user.email "[email protected]"

For more information, please see GitHub's guide to setting up Git.

Working on Windows

If you are working on a Windows environment you must ensure you commit all files with LF line endings. Please make sure you set the following options:

	$ git config --global core.autocrlf false
	$ git config --global core.eol lf

When reviewing a commit, if the entire file looks as though it has changed (and not just individual lines) then chances are the line endings are incorrect.

Edit this page on GitHub