ModComponent SDK

Appearance


Page authors

Deaadman

SDK Documentation Contribution Guidelines ​

Contributing to the SDK documentation is a great way to help improve the project. The documentation is built using VitePress and is maintained in the documentation branch of the ModComponent SDK repository.

INFO

This guide is based around using the commands for git, however if you have an application that handles git commands, then you don't have to worry about these commands.

Step 1: Fork and Clone the Repository ​

  1. Navigate to the ModComponent SDK repository on GitHub.
  2. Click the Fork button in the top-right corner to create your own copy of the repository.
  3. Clone your forked repository to your local machine:
shell
git clone https://github.com/your-username/ModComponentSDK.git
  1. Navigate to the cloned directory and switch to the documentation branch:
shell
cd ModComponentSDK
git checkout documentation

Step 2: Set Up the Documentation Environment ​

  1. Make sure you have Node.js installed on your system.
  2. Install the necessary dependencies:
shell
npm install
  1. Start the local development server:
shell
npm run docs:dev
  1. Open your browser and navigate to http://localhost:5173 to see the documentation site.

Step 3: Make Your Changes ​

  1. Create a new branch for your changes:
shell
git checkout -b documentation/your-feature-name
  1. Make your desired changes to the documentation files.
  2. As you make changes, the local development server will automatically update, allowing you to preview your modifications in real-time.

Step 4: Commit Your Changes ​

  1. Stage your changes:
shell
git add .
  1. Commit your changes with a clear and concise message:
shell
git commit -m "Added information about new feature X"

Step 5: Push Your Changes and Create a Pull Request ​

  1. Push your changes to your forked repository:
shell
git push origin documentation/your-feature-name
  1. Navigate to the original ModComponent SDK repository on GitHub.
  2. Click on "Pull requests" and then "New pull request".
  3. Select your fork and the branch containing your changes.
  4. Fill out the pull request template, providing a clear description of your changes.
  5. Submit the pull request.