Contribution Guidelines

Installation & Local Development

1. Ensure you have the following software on your system:

   • Python 3.12.1+
   • Pip 24.0 (Packaged with Python 3.12+)
   • Git / GitHub Desktop
   • An editor, like Visual Studio Code

2. Clone the StoryfireMC/Feature-Docs repo from GitHub:

   Cloning via SSH (With an SSH Key)

   1. Generate an SSH Key, it is NOT recommended to share SSH keys between projects/authentication. Generate one just for the Storyfire Oasis.
      

      Run ssh-keygen -t rsa -b 4096 -C "your-email@storyfire.com" to generate your key.

   2. Run git clone git@github.com:StoryfireMC/Feature-Docs

      Git will automatically use ~/.ssh/id_rsa - if you want to use a different key, use a command such as:

      ssh-agent bash -c 'ssh-add /somewhere/yourkey; git clone git@github.com:StoryfireMC/Feature-Docs'

   Cloning via HTTPS (With a GitHub PAT)

   1. Generate a GitHub Personal Access Token (PAT).
   2. Run git clone https://{GITHUB_PAT}@github.com/StoryfireMC/Feature-Docs.

3. Open your favourite code editor and add the new cloned folder to your workspace.

4. Run pip install -r requirements.txt to install the required packages.
5. Run mkdocs serve to serve your site locally at http://127.0.0.1:8000.

---

Committing (via PR)

1. Verify your changes: git status
2. Create a new branch: git checkout -b branch_name

   Use format your-name/your-feature when creating branches - e.g. jack/docs-renting-properties

3. Commit your changes: git commit -m "feat: ✨ Did a thing"

   Use Semantic Commits (See below)

4. Push to your new branch: git push origin branch_name
5. Create your PR: by visiting the Pull Requests tab of the repository.
6. Request a review: from jsJack or LilyLindstrand.

---

Guide: Semantic Commits

You must use the conventional commit standard to have your pull request merged.
Read more about the conventional commit standard.

You have been warned! Your commit will not be merged by the Dev Manager: