|
1 | | -# Contributing to GitHub-Automation-Scripts |
2 | | - |
3 | | -First off, thanks for taking the time to contribute! ❤️ |
4 | | - |
5 | | -All types of contributions are encouraged and valued. See the [Table of Contents](#table-of-contents) for different ways to help and details about how this project handles them. Please make sure to read the relevant section before making your contribution. It will make it a lot easier for us maintainers and smooth out the experience for all involved. The community looks forward to your contributions. 🎉 |
6 | | - |
7 | | -> And if you like the project, but just don't have time to contribute, that's fine. There are other easy ways to support the project and show your appreciation, which we would also be very happy about: |
8 | | -> - Star the project |
9 | | -> - Tweet about it |
10 | | -
|
11 | | - |
12 | | -## Table of Contents |
13 | | - |
14 | | -- [Asking Questions](#asking-questions) |
15 | | -- [How To Contribute](#how-to-contribute) |
16 | | -- [Styleguides](#styleguides) |
17 | | - |
18 | | - |
19 | | -## Asking Questions |
20 | | - |
21 | | -If you want to ask a question, join the 'GitHub Automation scripts' project channel on the GSSoC discord server. To join the project channel, make sure you have the 'GitHub Automation scripts' & 'Contributor' role assigned to you. If you don't have the role assigned to you, you can self-assign it in the [#self-roles](https://discord.com/channels/1099745007172329592/1099745007675646046) channel. |
22 | | - |
23 | | -Before you ask a question, it is best to search for existing [Issues](https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts.git/issues) that might help you. It is also advisable to search the internet for answers first. |
24 | | - |
25 | | -If you still feel the need to ask a question and need clarification, we recommend the following: |
26 | | - |
27 | | -- Provide as much context as you can about what you're running into. |
28 | | -- Provide details about your OS and environment. |
29 | | - |
30 | | - |
31 | | -## How To Contribute |
32 | | - |
33 | | -- Fork the project on GitHub, clone it on your PC. |
34 | | -- If you have an idea for an enhancement or a bug you can first check the [Issues](https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts.git/issues) to see if your question has been asked before. |
35 | | -- If you'd like to work on an issue, please ask the creator of the issue to assign it to you. This helps to keep the workflow streamlined. |
36 | | -- Create a new branch for your contribution and make the changes you want to make. (Always check for updates on the main branch before creating a pull request to avoid merge conflicts.) |
37 | | -- The pull request should mention the issue it is trying to solve and should be linked to it. Here is a video on how to link PRs to issues - [video link](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword). |
38 | | -- Make sure to make the appropriate changes in the README.md file if you are adding a new script or feature. |
39 | | - |
40 | | - |
41 | | -## Styleguides |
42 | | - |
43 | | -This project uses the Flake8 linter to lint the Python code. If you are using VSCode, I would suggest installing the [Flake8 linter extension](https://marketplace.visualstudio.com/items?itemName=ms-python.flake8) for VSCode. |
| 1 | +### 🧑💻 Contribution Guidelines |
| 2 | + |
| 3 | + |
| 4 | +## Introduction |
| 5 | +Welcome to the GitHub Automation Script project! Here, you will find everything you need to know about automating your GitHub workflows and supercharging your development process. |
| 6 | +GitHub is a powerful platform for collaboration and version control, enabling teams and individuals to work together seamlessly on projects of all sizes. However, managing repetitive tasks, ensuring code quality, and streamlining deployment can be time-consuming and error-prone. |
| 7 | + |
| 8 | +That's where the GitHub Automation Script comes in. |
| 9 | + |
| 10 | +## Getting Started |
| 11 | +We deeply value your enthusiasm for enhancing this project! We warmly welcome your valuable contributions and invite you to participate in elevating it to new heights. |
| 12 | + |
| 13 | +There are some steps that you need to follow before making any contribution in this project, the following steps are important to get start. |
| 14 | + |
| 15 | +### Step 1. Fork the Repository |
| 16 | + [Fork](https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts) the repo first |
| 17 | + |
| 18 | + ### Step 2. Clone the forked Repository |
| 19 | + ``` |
| 20 | + git clone https://github.com/<your_GitHub_username>/GitHub-Automation-scripts.git |
| 21 | + ``` |
| 22 | +### Step 3. Set Up Remotes |
| 23 | +- Add a reference (remote) to the original repository: |
| 24 | + ``` |
| 25 | + git remote add upstream https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts.git |
| 26 | + ``` |
| 27 | + - Add a reference (remote) to your forked repository: |
| 28 | +``` |
| 29 | +git remote add origin https://github.com/<your_GitHub_username>/GitHub-Automation-scripts.git |
| 30 | +``` |
| 31 | +
|
| 32 | +### Step 4. Check Remotes |
| 33 | +``` |
| 34 | +git remote -v |
| 35 | +``` |
| 36 | +
|
| 37 | +### Step 5. Keep Your Local Copy Updated |
| 38 | +``` |
| 39 | +git pull upstream main |
| 40 | +``` |
| 41 | +### Step 6. Create a New Branch |
| 42 | +``` |
| 43 | +git checkout -b <your_branch_name> |
| 44 | +``` |
| 45 | +
|
| 46 | +## Making Changes |
| 47 | +Perform your desired changes to the code base. |
| 48 | +
|
| 49 | +### Step 7. Track Changes |
| 50 | + ``` |
| 51 | + # Track the changes |
| 52 | + git status |
| 53 | +
|
| 54 | + # Add changes to Index |
| 55 | + git add . or git add <file_name> |
| 56 | + ``` |
| 57 | +### Step 8. Commit Changes |
| 58 | + ``` |
| 59 | + git commit -m "Write a meaningful but small commit message" |
| 60 | + ``` |
| 61 | + ### Step 9. Push Changes |
| 62 | +``` |
| 63 | +git push -u origin <your_branch_name> |
| 64 | +``` |
| 65 | +### 10. Compare and Create |
| 66 | +- Click on "Compare And Pull Requests" 🔄 |
| 67 | +- Make sure your pull request adheres to our contribution guidelines. Pull requests that do not meet the guidelines may be closed or discarded ❌ |
| 68 | +- Add an appropriate title and description to your pull request, explaining your changes with suitable explanations and screenshots 📝🖼️ |
| 69 | +- Click on "Create Pull Request" to submit your contribution for review ✅ |
| 70 | +
|
| 71 | +We appreciate your understanding and cooperation in following our guidelines. Thank you for your contribution! 🙌 |
| 72 | +Follow the existing code style and formatting conventions. |
| 73 | +
|
| 74 | +Maintain consistency with the overall project structure and organization. |
| 75 | +
|
| 76 | +Write clear and concise code with appropriate comments where necessary. |
| 77 | +
|
| 78 | +Ensure your code is free from errors and runs without issues. |
| 79 | +
|
| 80 | +Congratulations! You've made your PR with the desired changes. Once the PR is reviewed, it will be merged into the original codebase for everyone to see and use. |
| 81 | +
|
| 82 | +## Thank You! |
| 83 | +Thank you so much for considering contributing to GitHub-Automation-scripts project. We appreciate your valuable input, and we hope to see you again soon. 😊 |
| 84 | +For any further questions or assistance, please reach out to the project maintainers or refer to the project's documentation. git |
0 commit comments