Merge pull request #6 from um-csnet/dev

Improved documentations

README.md

@@ -13,9 +13,91 @@ This page is created using Jekyll and the Jekyll Chirpy Theme. To learn how to u
 
 ## Contributing
 
-Contributions (_pull requests_, _issues_, and _discussions_) are what make the open-source community such an amazing place
-to learn, inspire, and create. Any contributions you make are greatly appreciated.
-For details, see the "[Contributing Guidelines][contribute-guide]".
+Two ways to contribute to this project.
+
+- Github Fork and Pull Request (Recommended)
+- Contacting Webadmin
+
+If you want to submit a writeup, make sure it follows the Writeups Guideline ("Steps for writeups" post)
+
+### How to Contribute to a Project Using GitHub Fork and Pull Request
+
+Contributing to open-source projects on GitHub is a fantastic way to improve your coding skills, collaborate with other developers, and contribute to the software community. This guide will walk you through the process of contributing to a project using the fork and pull request model.
+
+#### Step 1: Fork the Repository
+
+1. **Find the Repository**: Navigate to the GitHub page of the project you want to contribute to.
+2. **Fork the Repository**: Click the "Fork" button in the top-right corner of the page. This creates a copy of the repository in your GitHub account.
+
+#### Step 2: Clone the Forked Repository
+
+1. **Clone Your Fork**: On your fork's GitHub page, click the "Clone or download" button and copy the URL.
+2. **Clone Locally**: Open your terminal and run the following command:
+    ```
+    git clone [URL of the forked repo]
+    ```
+
+#### Step 3: Create a New Branch
+
+1. **Navigate to Your Repository**: Change directory into the cloned repository:
+    ```
+    cd [repository-name]
+    ```
+2. **Create a New Branch**: Use the `git checkout` command to create a new branch:
+    ```
+    git checkout -b [new-branch-name]
+    ```
+
+#### Step 4: Make Changes and Commit
+
+1. **Make Your Changes**: Edit, add, or remove files in your local repository.
+2. **Stage the Changes**: Use `git add` to stage your changes:
+    ```
+    git add .
+    ```
+3. **Commit the Changes**: Commit your changes with a descriptive message:
+    ```
+    git commit -m "Add a brief description of your changes"
+    ```
+
+#### Step 5: Push Changes to GitHub
+
+1. **Push Your Branch**: Push your changes to GitHub:
+    ```
+    git push origin [your-branch-name]
+    ```
+
+#### Step 6: Create a Pull Request
+
+1. **Open Pull Request**: Go to the original repository on GitHub. You should see a prompt to create a pull request from your new branch.
+2. **Create Pull Request**: Click the "Compare & pull request" button. Add a detailed description of your changes and submit.
+
+#### Step 7: Respond to Feedback
+
+1. **Review and Respond**: Maintainers might leave feedback. Be sure to respond and make any necessary changes.
+2. **Update Pull Request**: If you make changes after feedback, push them to your branch. The pull request will automatically update.
+
+#### Conclusion
+
+These are basics steps in contributing to open-source projects using GitHub. By following these steps, you can effectively contribute to projects and collaborate with the global developer community.
+
+Your contributions does not limit to only submitting writeups
+- Web improvements
+- Fix typos
+- Improving the documentations
+
+### Contacting Webadmin to publish writeups
+
+> This method only for submitting writeups to webadmin for it to be on side
+{: .prompt-info }
+
+## Reach out to the webadmin with a complete writeups that follows the [`Writeups Guideline`](/posts/writeups-example/)
+
+## Web Administrators
+
+- [Irfan](mailto:[email protected])  : `[email protected]`
+- [Shafiq](mailto:[email protected]) : `[email protected]`
+- [Dr Faiz](mailto:[email protected])      : `[email protected]`
 
 ## Contributors
 

_posts/2019-08-08-how-to-contribute.md

@@ -0,0 +1,96 @@
+---
+title: Complete guide for contributing to this page
+author: [capang]
+date: 2024-01-01 09:30:00 +0800
+categories: [Documentation, Tutorial]
+tags: [Documentation]
+pin: true
+render_with_liquid: false
+---
+This tutorial will guide you how to contribute to this page. Theres 2 ways to contribute
+- Github Fork and Pull Request (Recommended)
+- Contacting Webadmin
+
+> If you want to submit a writeup, make sure it follows the [`Writeups Guideline`](/posts/writeups-example/)
+{: .prompt-info }
+
+# How to Contribute to a Project Using GitHub Fork and Pull Request
+
+Contributing to open-source projects on GitHub is a fantastic way to improve your coding skills, collaborate with other developers, and contribute to the software community. This guide will walk you through the process of contributing to a project using the fork and pull request model.
+
+## Step 1: Fork the Repository
+
+1. **Find the Repository**: Navigate to the GitHub page of the project you want to contribute to.
+2. **Fork the Repository**: Click the "Fork" button in the top-right corner of the page. This creates a copy of the repository in your GitHub account.
+
+## Step 2: Clone the Forked Repository
+
+1. **Clone Your Fork**: On your fork's GitHub page, click the "Clone or download" button and copy the URL.
+2. **Clone Locally**: Open your terminal and run the following command:
+    ```
+    git clone [URL of the forked repo]
+    ```
+
+## Step 3: Create a New Branch
+
+1. **Navigate to Your Repository**: Change directory into the cloned repository:
+    ```
+    cd [repository-name]
+    ```
+2. **Create a New Branch**: Use the `git checkout` command to create a new branch:
+    ```
+    git checkout -b [new-branch-name]
+    ```
+
+## Step 4: Make Changes and Commit
+
+1. **Make Your Changes**: Edit, add, or remove files in your local repository.
+2. **Stage the Changes**: Use `git add` to stage your changes:
+    ```
+    git add .
+    ```
+3. **Commit the Changes**: Commit your changes with a descriptive message:
+    ```
+    git commit -m "Add a brief description of your changes"
+    ```
+
+## Step 5: Push Changes to GitHub
+
+1. **Push Your Branch**: Push your changes to GitHub:
+    ```
+    git push origin [your-branch-name]
+    ```
+
+## Step 6: Create a Pull Request
+
+1. **Open Pull Request**: Go to the original repository on GitHub. You should see a prompt to create a pull request from your new branch.
+2. **Create Pull Request**: Click the "Compare & pull request" button. Add a detailed description of your changes and submit.
+
+## Step 7: Respond to Feedback
+
+1. **Review and Respond**: Maintainers might leave feedback. Be sure to respond and make any necessary changes.
+2. **Update Pull Request**: If you make changes after feedback, push them to your branch. The pull request will automatically update.
+
+## Conclusion
+
+These are basics steps in contributing to open-source projects using GitHub. By following these steps, you can effectively contribute to projects and collaborate with the global developer community.
+
+Your contributions does not limit to only submitting writeups
+- Web improvements
+- Fix typos
+- Improving the documentations
+
+# Contacting Webadmin to publish writeups
+
+> This method only for submitting writeups to webadmin for it to be on side
+{: .prompt-info }
+
+## Reach out to the webadmin with a complete writeups that follows the [`Writeups Guideline`](/posts/writeups-example/)
+
+## Web Administrators
+
+- [Irfan](mailto:[email protected])  : `[email protected]`
+- [Shafiq](mailto:[email protected]) : `[email protected]`
+- [Dr Faiz](mailto:[email protected])      : `[email protected]`
+
+

_posts/2019-08-08-write-a-new-post.md

@@ -1,11 +1,11 @@
 ---
 title: Complete guide for a New Post
 author: [cotes,capang,shafiq]
-date: 2024-01-01 09:30:00 +0800
+date: 2024-01-02 09:30:00 +0800
 categories: [Documentation, Tutorial]
 tags: [Documentation]
-pin: true
 render_with_liquid: false
+order: 1
 ---
 
 This tutorial will guide you how to write a post in the _Chirpy_ template, and it's worth reading even if you've used Jekyll before, as many features require specific variables to be set.

_tabs/about.md

@@ -4,9 +4,6 @@ icon: fas fa-info-circle
 order: 4
 ---
 <div align="center">
-    <div>
-        <img src="/assets/img/favicons/android-chrome-192x192.png">
-    </div>
 
 <h1> MalayaHunter </h1>
 
@@ -21,12 +18,13 @@ Feel free to read the documentation prepared at [Documentation][documentation] o
 
 ## Contributing
 
-Contributions can be made by _pull request_/_issues_/contacting the admin of the website. For details, see the [Documentation][documentation] or [Github][github]
+Contributions can be made by _pull request_/_issues_/contacting the admin of the website. For details, see the [Contributing Guidelines][contributing]
 
 ## Contributors
 
 ![GitHub Contributors Image](https://contrib.rocks/image?repo=um-csnet/malayahunter)
 
+[contributing]: /malayahunter/posts/how-to-contribute/
 [wiki]: https://github.com/cotes2020/jekyll-theme-chirpy/wiki	
 [documentation]: /malayahunter/categories/documentation/
 [github]: https://github.com/um-csnet/malayahunter/