feat: contributing.md added

CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# 🌟 Contributing to OpenVPN • WireGuard 🌟
+
+Thank you for considering contributing to the OpenVPN • WireGuard Admin project! Contributions from developers like you help improve and enhance the project for everyone
+
+## Ways to Contribute
+
+We welcome contribution in various forms, including but not limited to:
+
+- Reporting bugs or issues 
+- Providing feedback on the existing codebase
+- Submitting fixes for identified issues
+- Proposing new features or enhancement
+- Improving documentation
+
+### Code of Conduct
+Please make sure to follow Code of Conduct before contributing to the project.
+
+### Getting Started
+
+#### 1️⃣ 🍴 `Fork` the repository
+
+<p>Create a personal copy of openvpn-wireguard-admin repository on Github.</p>
+<p>You can do this by clicking the Fork button on openvpn-wireguard-admin repository page.</p>
+
+![Screenshot 2024-05-13 145728](https://github.com/IP80808080/openvpn-wireguard-admin/assets/94137507/5b5ceaee-2735-4468-9a35-ee942978b57b)
+
+
+#### 2️⃣ 💻 Clone the repository locally:
+
+After forking the repository, clone it locally on your computer so that you can work on the code and make changes.
+```bash
+     $ git clone https://github.com/<YOUR-USERNAME>/openvpn-wireguard-admin.git
+```
+#### 3️⃣ 📂 Navigate: Move into the project folder.
+
+```bash
+$ cd <your-forked-project-folder>
+
+```
+
+#### 4️⃣ 🔗 Add Upstream: Link to the original repository.
+
+```bash
+$ git remote add upstream https://github.com/<author-account-username>/<original-project>.git
+```
+
+#### 5️⃣ 👀 Check Remotes: Verify the remote connections.
+
+```bash
+$ git remote -v
+```
+
+#### 6️⃣ 🌿 Create a new branch:
+<p>Before making any changes, create a new branch in your local repository.This is done to ensure that your changes are isolated from the main branch and can be easily reviewed and merged later.</p>
+
+```bash
+    $ git checkout -b <branch-name>
+```
+
+#### 7️⃣ Installation
+1️⃣
+```bash
+    pip install -r requirements.txt
+```
+
+2️⃣
+```bash
+    cd frontend
+```
+
+3️⃣
+```bash
+    npm install
+```
+
+4️⃣
+```bash
+    npm start
+```
+
+#### 8️⃣ ✍️ Make changes:
+<p> Start making changes to the code, fixing bugs, adding new features, etc.
+Push changes to the fork:</p>
+
+<p>Once the changes have been made, push them to your fork on Github.</p>
+
+```bash 
+$ git add .
+$ git commit -m "Description of changes"
+$ git push origin <branch-name>
+```
+
+#### 9️⃣ 🚚 Submitting a `Pull Request`
+
+<li>Make sure your changes are well-documented and include relevant tests.</li>
+<li>If you've added new functionality, include appropriate documentation.</li>
+<li>Follow the coding conventions used in the project.</li>
+
+<p>Before submitting your pull request, make sure the following items have been checked:</p>
+<ol>
+ <li>All tests pass and the build is successful.</li>
+ <li>Your changes do not produce any new warnings or errors.</li>
+ <li>Your changes have been thoroughly tested on different platforms and browsers.</li>
+ <li>Your changes do not break backward compatibility.</li>
+ <li>When you're ready, submit a pull request and include a descriptive title and a detailed description of your changes.</li>
+<ol>
+
+
+## Acknowledgement
+Contributors are an integral part of this project, and all contributions will be recognized and appreciated. Your efforts help us improve and grow this project.
+
+<p>Thank you for your interest and contributions to our openvpn-wireguard-admin</p>