robloxapis/CONTRIBUTING.md

Library for working with Roblox Web API, contains a tool for the automatic construction of documented functions

# Contributing to Roblox API Client

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.

## Table of Contents

- [Setting Up the project locally](#setting-up-the-project-locally)
- [Submitting a Pull Request](#submitting-a-pull-request)

## Setting Up the project locally

To install the project you need to have `node` and `yarn` (can be replaced by NPM).

1.  [Fork](https://help.github.com/articles/fork-a-repo/) the project, clone
    your fork:

    ```sh
    # Clone your fork
    git clone https://github.com/<your-username>/RbxApiClient.git

    # Navigate to the newly cloned directory
    cd RbxApiClient
    ```

2. Create a `.dev` file in the root of the project. It is necessary so that `postinstall` doesn't invoke automatic rebuild of the API and the removal of the build script.

3.  from the root of the project: `yarn install` to install all dependencies.

    - make sure you have latest `yarn` version

4.  from the root of the project: `yarn run build` to build the API.

> Tip: Keep your `master` branch pointing at the original repository and make
> pull requests from branches on your fork. To do this, run:
>
> ```sh
> git remote add upstream https://github.com/StLyn4/RbxApiClient.git
> git fetch upstream
> git branch --set-upstream-to=upstream/master master
> ```
>
> This will add the original repository as a "remote" called "upstream," then
> fetch the git information from that remote, then set your local `master`
> branch to use the upstream master branch whenever you run `git pull`. Then you
> can make all of your pull request branches based on this `master` branch.
> Whenever you want to update your version of `master`, do a regular `git pull`.

## Submitting a Pull Request

Please go through existing issues and pull requests to check if somebody else is already working on it.