Skip to content

Latest commit

 

History

History
101 lines (66 loc) · 3.27 KB

CONTRIBUTING.md

File metadata and controls

101 lines (66 loc) · 3.27 KB
Raw

Contributing to Tiles

We appreciate your interest in contributing to Tiles! This document outlines the steps and guidelines for contributing to this project. By following these steps, you can ensure your contribution is smoothly integrated into the project.

Table of Contents

Prerequisites

Before you start contributing, make sure you have the following tools installed on your local machine:

Fork the Repository

  1. Navigate to the Tiles GitHub repository.
  2. Click the "Fork" button in the top-right corner of the page to create a copy of the repository in your GitHub account.

Clone the Repository

  1. Open a terminal/command prompt on your local machine.
  2. Navigate to the directory where you want to clone the repository.
  3. Run the following command:
  git clone https://github.com/YOUR_USERNAME/tiles.git

Replace YOUR_USERNAME with your GitHub username.

Create a New Branch

  1. Navigate to the cloned repository on your local machine:
  cd tiles
  1. Create a new branch using the following command:
  git checkout -b your-new-branch-name

Replace your-new-branch-name with a descriptive name for your branch, such as add-new-feature.

Make Changes

  1. Open the project in your preferred code editor.
  2. Make the necessary changes to the project. This could include adding new features, fixing bugs, or improving existing code.
  3. Test your changes to ensure they work correctly and do not introduce new bugs.

Commit Your Changes

  1. Stage the changes you made:
  git add .
  1. Commit the changes with a descriptive commit message:
  git commit -m "Your commit message here"

Replace Your commit message here with a brief description of the changes you made.

Push to Your Fork

  1. Push your changes to your forked repository on GitHub:
  git push origin your-new-branch-name

Replace your-new-branch-name with the name of your branch.

Submit a Pull Request

  1. Navigate to the Tiles GitHub repository.
  2. Click the "New pull request" button.
  3. Click "compare across forks" and select your forked repository and branch from the dropdown menus.
  4. Review the changes and click "Create pull request."
  5. Add a descriptive title and any additional comments, then click "Create pull request" again.

Code Review

Once you have submitted your pull request, the project maintainer(s) will review your changes. They may provide feedback and request changes before merging your contribution. Be sure to address their feedback and make any necessary changes to ensure a smooth integration into the project.

Thank you for your contribution! 🚀