diff --git a/docs/wiki/Guides/Contribution/Help-us-to-update-the-wiki/help-us-to-update-the-wiki.md b/docs/wiki/Guides/Contribution/Help-us-to-update-the-wiki/help-us-to-update-the-wiki.md new file mode 100644 index 00000000..5dabdf34 --- /dev/null +++ b/docs/wiki/Guides/Contribution/Help-us-to-update-the-wiki/help-us-to-update-the-wiki.md @@ -0,0 +1,58 @@ +## Table of Contents + +- [Introduction](#introduction) +- [Prerequisites](#prerequisites) +- [Steps to Contribute](#steps-to-contribute) + - [1. Create a Fork on GitHub](#1-create-a-fork-on-github) + - [2. Clone Your Fork](#2-clone-your-fork) + - [3. Make Your Changes](#3-make-your-changes) + - [4. Submit a Pull Request](#4-submit-a-pull-request) + +## Introduction + +Thank you for your interest in improving the wiki! This guide will help you through the process of contributing, whether you’re adding new pages, fixing errors, or enhancing existing content. + +## Prerequisites + +Before contributing, make sure you have: + +1. A GitHub account. +2. Basic knowledge of Markdown. + +## Steps to Contribute + +### 1. Create a Fork on GitHub + +To contribute, start by creating a fork of the repository: + +1. Go to the [GitHub page of the repository](https://github.com/Zagrios/bs-manager). +2. Click on the __`Fork`__ button in the top-right corner of the page. +3. Once the fork is created, it will appear under your GitHub account. + +### 2. Clone Your Fork + +Now, clone your fork to your local machine for editing: + +```bash +git clone https://github.com/[your-username]/[repository-name].git +cd [repository-name] +``` + +### 3. Make Your Changes + +Make edits, add new pages, or update content as needed. Then commit and push your changes to your fork: + +```bash +git add . +git commit -m "Describe your changes here" +git push origin master +``` + +### 4. Submit a Pull Request + +Once your changes are ready: + +1. Go to the __[original repository](https://github.com/Zagrios/bs-manager)__ on GitHub. +2. Click the __Pull Requests__ tab, then __New Pull Request__. +3. Compare changes between your fork and the original repository. +4. Add a clear description of your changes and submit the pull request. diff --git a/docs/wiki/Home.md b/docs/wiki/Home.md index bb8eeb52..73eaec40 100644 --- a/docs/wiki/Home.md +++ b/docs/wiki/Home.md @@ -33,8 +33,8 @@ Guidance on logging into BSManager to access all features Information on how to contribute to the development and improvement of BSManager -- ~~[Help us to update the wiki](help-us-to-update-the-wiki)~~ -- ~~[Contribute to the project](contribute-to-the-project)~~ +- [Help us to update the wiki](help-us-to-update-the-wiki) +- [Contribute to the project](https://github.com/Zagrios/bs-manager/blob/master/CONTRIBUTING.md) ## 🐞 Troubleshooting @@ -51,7 +51,7 @@ Our troubleshooting section is here to help you resolve common issues quickly an Steps to gather logs and identify specific issues - ~~[How to find your logs](How-to-find-your-logs)~~ -- ~~[Submitting a bug report](Submitting-a-bug-report)~~ +- [Submitting a bug report](https://github.com/Zagrios/bs-manager/issues/new?assignees=Zagrios&labels=bug&projects=&template=1-bug-report.yaml&title=%5BBUG%5D+%3A+) ***