Skip to content

Latest commit

 

History

History
61 lines (37 loc) · 2.8 KB

CONTRIBUTING.md

File metadata and controls

61 lines (37 loc) · 2.8 KB
Raw

Contributing

This page provides more detailed instructions on the offline contribution process. Due to the size of this repository, we highly recommend using the online options outlined in README.md.

Setting up Git

The first step to contributing is to install Git. GitHub has thorough documentation for setting up Git and Git LFS. On macOS, we recommend using Homebrew.

If you are new to Git, see Git Guides for explanations and tutorials. For a quick refresher on Git commands, see the Git Cheat Sheet.

If you want to avoid the command line, a Git client like GitHub Desktop can perform all the operations on this page---cloning, branching, displaying diffs, and committing---but use whichever tool you prefer.

Forking and Cloning

Instead of just cloning this repository, fork it on GitHub. Then clone your fork:

git clone https://github.com/your-username/your-fork.git

For instructions on keeping your fork in sync with Roblox/creator-docs over time, see Syncing a fork.

Creating a New Branch

After you clone your fork, create a new branch with a unique name. Creating branches keeps your work organized and discrete and helps avoid merge conflicts when you sync your fork with Roblox/creator-docs.

Because you eventually want to merge into the main branch, use it as the basis for your new branch.

  1. First, navigate to the repository root:

    cd creator-docs

  2. Then switch to the main branch (if you're not already on it):

    git checkout main

  3. Finally, create your new branch:

    git checkout -b your-new-branch

Opening Pull Requests

When you're happy with your changes, commit them to your branch. Include a short summary and longer description:

git commit -m "summary" -m "description"
git push origin your-branch

Then open Roblox/creator-docs on GitHub and click New Pull Request. Choose main as the base branch and your branch as the compare branch.

Add a title and description of your changes, confirm that the contribution is your own, original work that you have the right to submit, and create the pull request.