S1API

Appearance

Contributing to S1API ​

Welcome, potential contributor! We appreciate your interest in the S1API project. This guide will help you get started with contributing to the project.

Getting Started ​

S1API is an open source collaboration project aimed at standardizing Schedule One modding processes. The goal is to provide a standard place for common functionalities so modders can focus on making content versus reverse engineering the game.

How to Build the Project ​

Before contributing, you'll need to set up your development environment and learn how to build the project. Please refer to our detailed Building the Project guide.

Proper Contributing Channels ​

  • GitHub Issues: For bug reports, feature requests, and general discussion
  • Pull Requests: For submitting your contributions
  • Discord Server: For real-time discussion and collaboration (link to be added)

Contribution Process ​

  1. Fork the Repository: Start by forking the S1API repository to your GitHub account.

  2. Set Up Development Environment: Clone your fork to your local machine and set up the development environment.

  3. Choose an Issue: Look for open issues on the GitHub issue tracker, or propose a new feature or improvement.

  4. Create a Branch: Create a new branch for your work with a descriptive name.

  5. Implement Changes: Make your changes following our Coding Standards.

  6. Write Tests: Add appropriate tests for your changes.

  7. Submit a Pull Request: Push your changes to your fork and submit a pull request to the main repository.

  8. Code Review: Your code will be reviewed by maintainers, who may request changes.

  9. Merge: Once approved, your changes will be merged into the main codebase.

Understanding the Coding Standards ​

Before contributing, please thoroughly read over our Coding Standards documentation. These standards ensure the project remains consistent and predictable.

Documentation Guidelines ​

We use VitePress for our documentation site. If you're contributing to the documentation, please refer to our VitePress Documentation Guide to understand how to write and format content effectively.

Released under the MIT License.