Skip to content
This repository has been archived by the owner on Mar 17, 2022. It is now read-only.

Latest commit

 

History

History
61 lines (32 loc) · 2.85 KB

CONTRIBUTING.md

File metadata and controls

61 lines (32 loc) · 2.85 KB
Raw

Contributing Guide

Note From Repository Owner

Hello, as you may know by now, I (Carsa), no longer play Stormworks so updates are unlikely and bug fixes will be challenging, if even attempted. I will however remain involved with maintaining the project here and on the Steam Workshop.

This guide should help anyone willing to help keep this project alive

New contributor guide

  • You will want to have a good understanding of Stormworks Lua, as it differs from your typical Lua. It is missing metatables and has various other odd limitations.

  • Take a look over the main lua file

Getting started

Discussing

Would you like to discuss an idea you have for the script, ask a question, or just talk generally about the script? Head over to the discussions page!

Issues

Create a new issue

  • Found a bug when using the script in Stormworks? Have a feature you would like to suggest? Create an issue on this github repository.

  • There is a template for a bug report and a template for a feature request pre-made for you.

Solve an issue

  • Take a look through the issues on the repository

Making changes

  1. Fork the main branch on GitHub

  2. Create a branch where you will make your changes

  3. Make your changes

  4. Commit your update

  5. Create a pull request

Pull Request

Once you have finished your changes and committed them, it is time to make a pull request (PR).

  • Create a pull request and use the template provided. Take note of the issue number(s) that you are addressing with this pull request. If an issue does not yet exist for the things you are addressing, please first create an issue for each distinct topic you are editing. This will make things more organized so please do make sure to do so.

  • Make sure you enable the checkbox that allows maintainer edits, this allows maintainers of this repo to help prepare your edits for a merge, if needed.

  • At this point, a maintainer of the repo will look through your edits and make comments on your PR and/or make some adjustments to your changes.

  • As comments and suggestions are added and you make more changes, make sure to mark conversations as resolved so it is easy to keep track of what still needs work and what has already been accomplished.

Merging time

When everything is looking good, your PR will be merged by a maintainer of the repo - congratulations! And thank you! Your efforts to keep this script as good as it can be are greatly appreciated.