Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
robertnitu02 authored May 12, 2024
1 parent 3bbc885 commit 9062545
Showing 1 changed file with 54 additions and 0 deletions.
54 changes: 54 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# B-Zone V Wiki

Welcome to the official Wiki page for B-Zone V !

## About

This Wiki serves as a central repository for all information related to the B-Zone V Roleplay Server. Here, you can find documentation, guides, FAQs, and more to help you understand and contribute to the project.

## Live Version

Click here to see the current Wiki B-Zone V page: [Wiki page](https://b-zone-gta-v.github.io/B-Zone-GTA-V-Wiki/).

## How to Contribute

Contributions to the Wiki are highly appreciated and encouraged! Whether you're fixing a typo, adding new content, or improving existing documentation, your contributions help make this resource more valuable for everyone.

To contribute to the Wiki, follow these steps:

1. **Fork the Repository:** Click the "Fork" button at the top-right corner of this page to create a copy of the repository in your GitHub account.

2. **Clone the Repository:** Clone the forked repository to your local machine using Git. Replace `[username]` with your GitHub username:
```bash
git clone https://github.com/[username]/B-Zone-GTA-V-Wiki
```

3. **Install VitePress:** Here you can find the documentation: https://vitepress.dev/guide/getting-started

4. **Make Changes:** Navigate to the cloned repository on your machine and make the necessary changes to the Wiki pages. You can edit existing pages, create new pages, or upload images and files as needed.

5. **Commit Changes:** Once you've made your changes, commit them to your forked repository with descriptive commit messages:
```bash
git add .
git commit -m "Add/update [description of changes]"
```

6. **Push Changes:** Push your changes to your forked repository on GitHub:
```bash
git push origin master
```

7. **Submit a Pull Request (PR):** Go to your forked repository on GitHub and click the "New Pull Request" button. Describe the changes you've made in the PR description and submit the PR for review.

8. **Review and Merge:** After submitting a PR, the maintainers of this repository will review your changes. Once approved, your changes will be merged into the main Wiki repository.


## Need Help?

If you have any questions or need assistance with contributing to the Wiki, feel free to reach out to us by opening an issue in this repository.

Thank you for contributing to B-Zone V Wiki!

<p align="center">
<img src="https://media.giphy.com/media/jpVnC65DmYeyRL4LHS/giphy.gif" width="20%">
</p>

0 comments on commit 9062545

Please sign in to comment.