Skip to content

Latest commit

 

History

History
41 lines (40 loc) · 2.63 KB

CONTRIBUTING.md

File metadata and controls

41 lines (40 loc) · 2.63 KB
Raw

Contributors Guide

Thanks so much for checking out Tiny Troves.

This repo provides a beginner-friendly way for non-game devs to contribute to a simple Unity project.

All contributors are invited to add their name and piece of advice to a .txt file in the repo. This file will then be parsed into a dictionary during runtime.

💎Ready to get started? Simply follow the steps below.💎

  1. Open up the Advice.txt file

    • In the project repo, navigate to TinyTroves/Assets/Advice.
    • Click the file Advice.txt (NOTE: Do not modify Advice.txt.meta).
    • In the top right-hand corner, click Edit this file (looks like a tiny pencil).
    • Follow the instructions to fork the repo.

  2. Add your name and piece of wisdom

    • Inside the Advice.txt file, navigate to the the next empty line in the text file.
    • Enter in your name, followed by #. If your name is Bob, your entry would look like this: Bob#
    • Following your name, enter in your piece of advice. Please ensure that:
      • Your advice is 100 characters or less.
      • There is a space between your name and the piece of advice.
      • Both your name and advice are no longer than one line long.
    • To reiterate, each entry in the Advice.txt file must be no longer than one line long in order for the code to compile properly.
    • For example, Bob's entry in the text file might look like this:

      Bob# Code like no one is watching, but always assume someone is debugging your code.

  3. Start a pull request

    • Once you have added your entry, click Commit Changes in the top right-hand corner of the editor.
    • Enter a commit message, then click Propose Changes.
    • On the next screen, click the green Create Pull Request button.
    • Optional: Leave a comment on your pull request.
    • When your pull request is ready to submit, click Create Pull Request.
    • That's it! You can view the current build of the project here. Note that new builds are only generated periodically so it may be some time once your pull request has been merged before your contribution is viewable in the game!

💎Thanks so much for contributing to the Tiny Troves project!💎