Skip to content

Latest commit

 

History

History
37 lines (31 loc) · 2.05 KB

CONTRIBUTING.md

File metadata and controls

37 lines (31 loc) · 2.05 KB

Contributing Guide

Getting Started

To get started with the project, follow these steps:

  1. Open Unity Hub.
  2. Click on the New Project button in the top right.
  3. Select the 3D (URP) template.
  4. Name your project and choose where to store it.
  5. Select the Unity Editor version (2022.3.7f1 is recommended).
  6. Click the Create Project button.
  7. Open a terminal and navigate to the Assets directory of the project.
  8. Clone this repository using the following command:

    git clone https://github.com/Preponderous-Software/beyond-nations

  9. In Unity, navigate to the beyond-nations/src directory, which should now be in the Assets folder.
  10. Double click on the main scene to open it.

Troubleshooting

If you encounter a Missing Editor Version error, it's probably because you tried to open the repository folder directly as a Unity project. It's recommended to clone the repository inside the Assets folder of an existing empty project.

Branching

To keep the codebase organized, we use a branching model that is similar to Git Flow. The main branch is the default branch, and it contains the latest stable version of the codebase. The develop branch contains the latest version of the codebase, and it is the branch that should be used for development.

Pull Requests

To contribute to the project, you must create a pull request. A pull request is a request to merge your changes into the develop branch. To create a pull request, follow these steps:

  1. Create a new branch from the develop branch.
  2. Make your changes.
  3. Commit your changes.
  4. Push your changes to the remote repository.
  5. Create a pull request on GitHub.
  6. Wait for your pull request to be reviewed, approved & merged. Comments may be made on your pull request, and you may be asked to make changes.

Issues

If you encounter a bug or have a feature request, you can create an issue. An issue is a way to report a bug or request a feature. To create an issue, follow these steps:

  1. Create a new issue on GitHub.
  2. Describe the bug or feature request.
  3. Wait for the issue to be reviewed and resolved.