-
Notifications
You must be signed in to change notification settings - Fork 98
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #187 from Nidhi1314/gsoc-readme-improvements
Improve README: Guidelines & Description
- Loading branch information
Showing
1 changed file
with
47 additions
and
50 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,95 +1,92 @@ | ||
|
|
||
|  | ||
|
|
||
| # About Our Project 💻 | ||
| # Physi-c-Tech 💻 | ||
| Welcome to the **Physi-c-Tech** project! We're building something amazing with love, brains, and responsibility. Our project aims to create a cutting-edge physics-based multiplayer game that combines fun and learning. Whether you're a seasoned developer or just starting, we would love for you to join us on this exciting journey. | ||
|
|
||
| <div align="center"> | ||
| <img src="https://forthebadge.com/images/badges/built-with-love.svg" /> | ||
| <img src="https://forthebadge.com/images/badges/uses-brains.svg" /> | ||
| <img src="https://forthebadge.com/images/badges/powered-by-responsibility.svg" /> | ||
| <br> | ||
| <img src="https://img.shields.io/github/repo-size/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues-pr/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues-pr/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues-closed-raw/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues-pr-closed-raw/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/license/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/forks/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/stars/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/contributors/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/last-commit/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| </div> | ||
|
|
||
| <img src="https://img.shields.io/github/issues/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues-closed-raw/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/issues-pr-closed-raw/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/license/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/forks/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/stars/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/contributors/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| <img src="https://img.shields.io/github/last-commit/GameSphere-MultiPlayer/Physi-c-Tech?style=for-the-badge" /> | ||
| </div> | ||
| # How to Contribute 🟢 | ||
| We’re excited to have you contribute to our project! Here’s how you can get started: | ||
|
|
||
| # How to make a PR in a Project 🟢 | ||
| ## Using the Command Line | ||
|
|
||
| If you are interested to contribute in this project how to start contribute | ||
| <!-- in detail --> | ||
| 1. **Fork the repository**: This creates a copy of the project in your GitHub account. Click the "Fork" button at the top right of this page. | ||
|
|
||
| 1. Fork the repo. | ||
|
|
||
| 2. After forking, clone the repo to your local machine. | ||
| To clone the repo to your local machine, run the following command in your terminal: | ||
|
|
||
| 2. **Clone the repository to your local machine**: | ||
| ```bash | ||
| git clone https://github.com/<your-github-username>/Physi-c-Tech | ||
| ``` | ||
| Replace `<your-github-username>` with your GitHub username. | ||
|
|
||
| 3. Add a remote upstream to the original repo. | ||
| To add a remote upstream, run the following command in your terminal: | ||
|
|
||
| 3. **Add a remote upstream to the original repository**: This ensures you can pull in changes from the main project. | ||
| ```bash | ||
| git remote add upstream https://github.com/Durgesh4993/Physi-c-Tech/ | ||
| git remote add upstream https://github.com/GameSphere-MultiPlayer/Physi-c-Tech/ | ||
| ``` | ||
|
|
||
| 4. Create a new branch. | ||
| To create a new branch, run the following command in your terminal: | ||
|
|
||
| 4. **Create a new branch**: It's good practice to create a new branch for each feature or fix you work on. | ||
| ```bash | ||
| git checkout -b <your-branch-name> | ||
| ``` | ||
| 5. Make changes in source code. | ||
| 5. **Make changes to the source code**: Tweak, enhance, and improve! | ||
| 6. Add your changes | ||
| To add your changes, run the following command in your terminal: | ||
|
|
||
| 6. **Add your changes**: Stage the files you want to include in your commit. | ||
| ```bash | ||
| git add <File1 changed> <File2 changed> ... | ||
| git add <file1> <file2> ... | ||
| ``` | ||
| 7. Commit your changes. | ||
| To commit your changes, run the following command in your terminal: | ||
|
|
||
| 7. **Commit your changes**: Write a meaningful commit message. | ||
| ```bash | ||
| git commit -m "<your-commit-message>" | ||
| ``` | ||
| 8. Push your changes. | ||
| To push your changes, run the following command in your terminal: | ||
|
|
||
| 8. **Push your changes**: Send your changes to GitHub. | ||
| ```bash | ||
| git push origin <your-branch-name> | ||
| ``` | ||
| 9. Create a PR. | ||
| 9. **Create a pull request (PR)**: Go to your forked repository on GitHub and you’ll see a button to create a PR. Click it and submit your changes for review. | ||
| __________________________________________________________________________________________________________________________________________________________________ | ||
| ## Using GitHub Desktop | ||
| ## Alternatively Using GitHub Desktop | ||
| 1. **Open GitHub Desktop** and log in to your GitHub account. | ||
| 1. Open GitHub Desktop and log in to your GitHub account. | ||
| 2. **Add your local repository**: | ||
| - Go to "File" > "Add Local Repository" and select your repository. | ||
| 2. Make sure you are on the "Current Repository" view. If not, go to "File" and select "Add Local Repository" to add your repository. | ||
| 3. **Ensure you are on the correct branch**: | ||
| - Use the "Branch" menu to switch if necessary. | ||
| 3. In the "Current Repository" view, ensure you are on the branch that you want to submit a pull request for. If you're not on the correct branch, use the "Branch" menu to switch to the correct branch. | ||
| 4. **Make and commit your changes**: | ||
| - Click the "+" button, make your changes, and enter a commit message. | ||
| 4. Once you're on the correct branch, make your changes and commit them to the branch. You can do this by clicking the "+" button in the upper-left corner of the GitHub Desktop window, making your changes, and then entering a commit message. | ||
| 5. **Push your changes**: | ||
| - Click the "Push origin" button. | ||
| 5. After you've made your changes and committed them, click the "Push origin" button in the top-right corner of the GitHub Desktop window. This will push your changes to the remote repository on GitHub. | ||
| 6. **Create a pull request** on GitHub: | ||
| - Navigate to your fork of the repository and click "Compare & pull request". | ||
| 6. Now, go to the GitHub website, navigate to your fork of the repository, and you should see a button to "Compare & pull request" between your fork and the original repository, click on it. | ||
| 7. **Review and submit your pull request**: | ||
| - Add a title and description, then click "Create pull request". | ||
| 7. On the pull request page, you can review your changes and add any additional information, such as a title and a description, that you want to include with your pull request. | ||
| **Note:** In order to create a pull request, you must have a fork of the original repository in your GitHub account and have made changes in that forked repository. | ||
| 8. Once you're satisfied with your pull request, click the "Create pull request" button to submit it. | ||
| # Need Help? | ||
| If you encounter any issues or have questions, feel free to open an issue in the repository or contact us directly. We’re here to help you get started and make meaningful contributions. | ||
| **Note:** In order to create a pull request, you must have a fork of the original repository in your GitHub account and you must have made the changes in that forked repository. | ||
| Thank you for your interest in contributing to **Physi-c-Tech**! Together, we can build something incredible. 🚀 |