Skip to content

Latest commit

 

History

History
136 lines (86 loc) · 5.09 KB

CONTRIBUTING.md

File metadata and controls

136 lines (86 loc) · 5.09 KB

Guess you're a contributor now!

This is the most important file for you to read as a contributor. If written well, this file will explain everything you need to know in order to successfully contribute to the project. If a project does not have this file, you should ask for guidelines by opening an issue.

Contributor's Guide

Thanks for your interest in contributing! Please read carefully through our guidelines below to ensure that your contribution adheres to our project's standards.

Code of Conduct

To hold a safe space for all contributors, we expect all project participants to adhere to our Code of Conduct. Please read the full text so that you can understand what actions will and will not be tolerated.

Issue Tracking

We use GitHub Issues to track all tasks related to this project.

To help you get your feet wet and get you familiar with our contribution process, we have a list of friendly issues (to be added soon) that contain tasks which are fairly easy to fix. This is a great place to get started.

Getting Started

Build the project locally

In order to contribute to a project on GitHub, you must first get a copy of the project running locally on your computer.

There are five steps to building this project:

  1. Set up Git and Install Android Studio
  2. Fork the repository
  3. Clone your fork
  4. Run the project

Once you get the project built, see if you can fix some issues(to be updated soon).

Set up Git and Install Android Studio

All GitHub projects are backed by a version control software called Git. You'll need to set up Git in order to contribute to any project on GitHub.

If you are new to Git and Github, it is advisable you go through this link before moving to the next step.

This specific project is written in Java, some parts in Kotlin. You'll need to install Android Studio in order to run the project.

Fork the repository

A fork is a copy of a repository. Forking a repository lets you to make changes to your copy without affecting any of the original code.

Click Fork (in the top-right corner of the page) to copy this repository to your GitHub account. Help Guide to Fork a repository.

Clone your fork

A clone is a downloaded version of a repository. Cloning our fork lets you download a copy of the repository to your computer.

Use git to clone your fork

$ git clone https://github.com/YOUR-USERNAME/LiveWhiteboard-App

Run the project

Open the project and Android Studio and start contributing.

Submitting a Pull Request

What is a pull request? Visit link

If you decide to fix an issue, it's advisable to check the comment thread in case there's somebody already working on a fix. If no one is working on it at the moment, kindly leave a comment stating that you intend to work on it so other people don't accidentally duplicate your effort.

In a situation where by somebody decides to fix an issue but doesn't follow up for a particular period of time, say 2-3 weeks, it's acceptable to still pick up the issue but make sure to leave a comment.

  1. Create a branch specific to the issue you are working on.

    git checkout -b update-readme-file

    For clarity to yourself and others on the issue you're working on, name your branch something like update-xxx or fix-xxx where xxx is a short description of the changes you're making. For example update-readme or fix-typo-on-contribution-md.

  2. Open up the project in your favourite text editor, select the file you want to contribute to and make your changes.

    If you are making changes to the README.md file, you would need to have Markdown knowledge. Visit here to read about Github Markdown and here to practice

  3. After making your changes in the new git branch then add your modified files to git.

    git add path/to/filename.ext

    You can also add all unstaged files using:

    git add .

    Note, using a git add . will automatically add all files. You can do a git status to see your changes, but do it before git add.

  4. Commit your changes using a descriptive commit message.

    git commit -m "Brief Description of Commit"

  5. Push your commits to your Github Fork:

    git push origin branch-name

  6. Submit a pull request.

    Within GitHub, visit this main repository and you should see a banner suggesting to make a pull request. While you're writing up the pull request, you can add Closes #XXX in the message body where #XXX is the issue you're fixing. So an example would be Closes #42 would close issue #42.

Helpful Resources