tm-pe2 / meta

A guide to working on the PE2 projects
1 stars 0 forks source link

Practice Enterprise Meta Hub

This repository is a hub for all information regarding PE2 and how to contribute to the project(s)
Have a question, idea or just have something to say? Start a discussion or get on the Discord server.

Getting started

In order to get full access to repo's, you need to be a member of the organization. To join the organisation ping Xunafay#0001 or Toast#1042 with your github username, you'll receive an invite link on your github email.

Once you've gained access to the organisation, you should join your teams:

Help I'm new to Git and GitHub

Follow the git handbook
Learn more about GitHub in the learning lab
A collection of Git and GitHub learning resources
GitHub features

This doesn't answer your question? Ping someone with the git role in the discord server.

Task Management

To track your work it is highly recommended to create an issue describing your task. This way there is an immutable history of what you've done.
Assign yourself to an issue to indicate to others your already working on it.

Here are some tips on using issues to organize your work better:

  1. Split tasks into smaller, more manageable issues. Use a task list to track these related issues.
  2. Use the project board to track and organize tasks.
  3. Use a pull request to close an issue and tracks its code.
  4. Use labels to describe and organize issues.

How to contribute code

Do not contribute to the main branch always create a new branch (optionally on a fork) and create a pull request.
This is called the GitHub flow, meant to prevent a lot of merge headaches. A complete guide can be found here

Tools that will help you

Love to use the CLI? GitHub CLI has you covered
GitHub Mobile keeps you update on your work on the go.

Github Desktop / GitKraken

Not so keen on using the command line? These apps provide a GUI for Git.

Github Desktop
GitKraken

Visual Studio Code

Visual Studio Code (VSCode) is an editor that supports many languages with the use of extensions.
VSCode has a built in Git tab used to see differences in files and commit changes.
Download Vscode