Survive The Wild (STW) Contribution Guidelines

Welcome to the Survive The Wild (STW) documentation project! We're excited to have you contribute to enhancing the documentation for this game developed by Sam Tupy. Your contributions will help players navigate quests, map directions, item crafting, and more effectively. Below are guidelines for contributing using GitHub Desktop and an alternative method via Telegram.

How to Contribute Using GitHub Desktop

  1. Fork the Documentation Repository
    Start by forking the documentation repository of STW to your GitHub account. This will create a personal copy where you can make changes.
  2. Clone the Repository with GitHub Desktop
    Open GitHub Desktop. Click on "File" in the menu and select "Clone repository." Choose the "URL" tab and paste the URL of your forked repository (https://github.com/your-username/stwguide.git). Select a local path where you want to clone the repository. Click on "Clone" to download the repository to your local machine.
  3. Make Changes Locally
    Open the cloned repository in your preferred text editor. Navigate to the section you'd like to contribute to, such as quests, map directions, or item crafting. Edit the Markdown files to make your changes. Ensure that your edits are clear, concise, and follow the established style and formatting guidelines.
  4. Commit Changes with GitHub Desktop
    Switch back to GitHub Desktop. You should see the changes you made listed under "Changes" tab. Write a brief summary of your changes in the "Summary" field. Optionally, provide a more detailed description in the "Description" field. Click on "Commit to main" to commit your changes locally.
  5. Push Changes to Your Fork
    After committing your changes, click on "Push origin" to push your commits to your forked repository on GitHub.
  6. Create a Pull Request
    Visit your forked repository on GitHub. You should see a banner indicating that you've recently pushed a new branch. Click on the "Compare & pull request" button. Review your changes and ensure everything looks good. Provide a descriptive title and detailed description for your pull request. Click on "Create pull request" to submit your changes for review.
  7. Review and Iterate
    Collaborate with maintainers and other contributors to review your pull request. Address any feedback or requested changes by making additional commits to your branch.
  8. Merge Your Pull Request
    Once your pull request has been approved, a maintainer will merge it into the main branch of the documentation repository. Congratulations on your contribution!

Alternative Contribution Method via Telegram

If you're unable to contribute using GitHub, you can send your documentation contributions via Telegram to harrymkt.

  1. Write your documentation contributions clearly, following the established style and formatting guidelines.
  2. Send your contributions to harrymkt on Telegram.
  3. Include a brief description of your changes and the section of documentation they apply to.

Reporting Issues

If you encounter any errors, inconsistencies, or have suggestions for improvements in the documentation, please open an issue on the GitHub repository. Provide a clear description of the issue or suggestion to help facilitate resolution.

Thank You!

Your contributions are invaluable in improving the documentation for Survive The Wild. Thank you for your dedication and effort in making the game more enjoyable for all players. If you have any questions or need assistance, feel free to reach out to the maintainers or community for support. Happy documenting!