Skip to content

Latest commit

 

History

History
77 lines (54 loc) · 3.87 KB

CONTRIBUTING.md

File metadata and controls

77 lines (54 loc) · 3.87 KB
Raw

Contributing to GitHub-Automation-Scripts

Ah, thank you ever so much for gracing us with your oh-so-valuable contributions! We're just thrilled to have you here. But wait, hold on! Don't just dive in and contribute your precious time. First, read the Table of Contents for different ways to help and details about how this project handles them. 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. 🎉

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:

  • Star the project
  • Tweet about it Remember, every bit of support, big or small, makes a significant difference, and we truly appreciate every gesture of encouragement you offer. Your appreciation fuels our passion for the project, and we're immensely grateful for your involvement in any form! ❤️🌟🐦

Table of Contents

Asking Questions

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 channel.

Before you ask a question, it is best to search for existing Issues that might help you. It is also advisable to search the internet for answers first.

If you still feel the need to ask a question and need clarification, we recommend the following:

  • Provide as much context as you can about what you're running into.
  • Provide details about your OS and environment.

How To Contribute

To start contributing, follow the guidelines given below:

1. Fork the Repository

Fork the repository (https://github.com/sahil-sagwekar2652/GitHub-Automation-scripts)

2. Clone the forked Repository

git clone https://github.com/<your_user_name>/GitHub-Automation-scripts.git

NOTE

  • If you have an idea for an enhancement or a bug you can first check the Issues to see if your question has been asked before.

  • 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.

3. Create a New Branch

git checkout -b <your_branch_name>

Making Changes

Perform your desired changes to the code base.

4. Track Changes

git add .

5. Commit Changes

git commit -m "Suitable message"

6. Push Changes

git push -u origin <your_branch_name>

Creating a Pull Request

To create a pull request:

  • 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.

  • Make sure to make the appropriate changes in the README.md file if you are adding a new script or feature.

  • Add an appropriate title and description to your pull request, explaining your changes with suitable explanations and screenshots 📝🖼️

  • Click on "Create Pull Request" to submit your contribution for review ✅

Styleguides

This project uses the Flake8 linter to lint the Python code. If you are using VSCode, I would suggest installing the Flake8 linter extension for VSCode.