Any and all help is appreciated on this game. If you contribute, please update the contributors.md file. Look at the issues tab for any features or things you want to work on and comment. First timers, women, and new contributors especially welcome.
If you see something that needs a fix, or you have an idea but don't have the time or interest to get to it, please create a new issue! There are several issue tags available - add the ones you think are most relevant. If it's a small, easy fix, be sure to add the "good first issue" tag to encourage folx that are to the project or are new developers to participate!
- Clone the repo
git clone https://github.com/ahl389/paint-run2.git- In your terminal, navigate to the project's root
cd paint-run2- Install the contents of
package.jsonto make sure you have all the needed dependencies by running
npm install- Create a new branch for yourself
git checkout -b <your-branch-name>- To see the app locally, from the project's root directory run:
npm startThen visit http://localhost:3000/
- When you're ready to stage and commit your changes, do so with:
git add .
git commit -m '<your commit message here>'- Then, push them to your branch:
git push origin <your-branch-name>-
Come back to the repo here, and create a pull request by hitting the
New Pull Requestbutton toward the top. Select your branch from the list. -
Don't forget - regularly stage and commit your changes. Also, it's good practice to regularly pull down from master to make sure you have the most up to date version of the code. With several contributors, things can get confusing quickly! Do your best to write useful comments where appropriate so other people know what your code is doing!