|
| 1 | +# **Contributing Guidelines** 📄 |
| 2 | + |
| 3 | +This documentation contains a set of guidelines to help you during the contribution process. |
| 4 | +We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. |
| 5 | +Thank you for helping out and remember, **no contribution is too small.** |
| 6 | +<br> |
| 7 | +Please note we have a [code of conduct](CODE_OF_CONDUCT.md) please follow it in all your interactions with the project. |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +<br> |
| 12 | + |
| 13 | +## **Need some help regarding the basics?🤔** |
| 14 | + |
| 15 | + |
| 16 | +You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, |
| 17 | +in case you are stuck: |
| 18 | + |
| 19 | +- [Forking a Repo](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) |
| 20 | +- [Cloning a Repo](https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request) |
| 21 | +- [How to create a Pull Request](https://opensource.com/article/19/7/create-pull-request-github) |
| 22 | +- [Getting started with Git and GitHub](https://towardsdatascience.com/getting-started-with-git-and-github-6fcd0f2d4ac6) |
| 23 | +- [Learn GitHub from Scratch](https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources) |
| 24 | + |
| 25 | +<br> |
| 26 | + |
| 27 | +## **Issue Report Process 📌** |
| 28 | + |
| 29 | +1. Go to the project's issues. |
| 30 | +2. Give proper description for the issues. |
| 31 | +3. Don't spam to get the assignment of the issue 😀. |
| 32 | +4. Wait for till someone is looking into it !. |
| 33 | +5. Start working on issue only after you got assigned that issue 🚀. |
| 34 | + |
| 35 | +<br> |
| 36 | + |
| 37 | +## How to Contribute |
| 38 | +We welcome contributions from the community to enhance GitGlance further.You can use GitHub Desktop to manage this repository. Here's how: |
| 39 | + |
| 40 | +1. **Download and Install GitHub Desktop**: |
| 41 | + - Go to the [GitHub Desktop website](https://desktop.github.com/) and download the GitHub Desktop application. |
| 42 | + - Follow the installation instructions to install GitHub Desktop on your computer. |
| 43 | + |
| 44 | +2. **Clone the Repository**: |
| 45 | + - Open GitHub Desktop and sign in to your GitHub account. |
| 46 | + - Click on the "File" menu, then select "Clone Repository..." |
| 47 | + - Choose the repository you want to clone from the list or enter its URL. |
| 48 | + - Choose the local path where you want to clone the repository and click "Clone". |
| 49 | + |
| 50 | +3. **Make Changes**: |
| 51 | + - After cloning the repository, you can make changes to the files locally using your preferred code editor. |
| 52 | + |
| 53 | +4. **Commit Changes**: |
| 54 | + - Once you've made changes, open GitHub Desktop. |
| 55 | + - You'll see a list of files with changes. Write a summary and description of your changes in the text fields. |
| 56 | + - Click "Commit to main" to commit your changes locally. |
| 57 | + |
| 58 | +5. **Push Changes**: |
| 59 | + - To push your changes to the remote repository on GitHub.com, click "Push origin". |
| 60 | + |
| 61 | +6. **Pull Changes**: |
| 62 | + - If there are changes on the remote repository that you don't have locally, you can pull them by clicking "Fetch origin" or "Pull origin". |
| 63 | + |
| 64 | +7. **Sync Changes**: |
| 65 | + - To synchronize your local repository with the remote repository, click "Sync" to push and pull changes in one step. |
| 66 | + |
| 67 | +That's it! You can now use GitHub Desktop to manage this repository efficiently. |
| 68 | + |
| 69 | +## **Pull Request Process 🚀** |
| 70 | + |
| 71 | +1. Ensure that you have self reviewed your code 😀 |
| 72 | +2. Make sure you have added the proper description for the functionality of the code |
| 73 | +3. I have commented my code, particularly in hard-to-understand areas. |
| 74 | +4. Add screenshot it help in review. |
| 75 | +5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀 |
| 76 | + |
| 77 | +<br> |
| 78 | + |
| 79 | +# **Thank you for contributing💗** |
0 commit comments