Skip to content

Latest commit

 

History

History
70 lines (47 loc) · 2.43 KB

CONTRIBUTING.md

File metadata and controls

70 lines (47 loc) · 2.43 KB
Raw

Contributing to TicTacToe

Please take a moment to review this document in order to make the contribution process easy and effective for everyone involved.

Following these guidelines helps to communicate that you respect the time of the developers managing and developing this open source project. In return, they should reciprocate that respect in addressing your issue or assessing patches and features.

Using the issue tracker

The issue tracker is the preferred channel for spelling mistakes, errors or any general feedback. Please respect the following restrictions:

  • Please do not derail or troll issues. Keep the discussion on topic and respect the opinions of others.

  • Please do not open issues or pull requests that involve including answers to any of the questions.

Pull requests

Please adhere to the coding conventions used throughout the project (spelling, indentation, punctuation etc.).

Adhering to the following process is the best way to get your work included in the project:

  1. Fork the project, clone your fork, and configure the remotes:

    # Clone your fork of the repo into the current directory
git clone https://github.com/<your-username>/salman-bhai/TicTacToe.git
# Navigate to the newly cloned directory
cd TicTacToe/
# Assign the original repo to a remote called "upstream"
git remote add upstream https://github.com/salman-bhai/TicTacToe.git

  2. If you cloned a while ago, get the latest changes from upstream:

    git checkout master
git pull upstream master

  3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:

    git checkout -b <topic-branch-name>

  4. Locally merge (or rebase) the upstream development branch into your topic branch:

    git pull [--rebase] upstream master

  5. Squash your commits down to a single one (we want to keep the master branch nice and clean)

  6. Push your topic branch up to your fork:

    git push origin <topic-branch-name>

  7. Open a Pull Request with a clear title and description.

IMPORTANT: By submitting patches, you agree to allow the project owners to license your work under the terms of the MIT License.