Skip to content

Latest commit

 

History

History
68 lines (50 loc) · 2.91 KB

CONTRIBUTING.md

File metadata and controls

68 lines (50 loc) · 2.91 KB
Raw

Contributing Guidelines 📄

This documentation contains a set of guidelines to help you during the contribution process. We are happy to welcome all the contributions from anyone willing to improve/add new scripts to this project. Thank you for helping out and remember, no contribution is too small.
Please note we have a code of conduct please follow it in all your interactions with the project.


Need some help regarding the basics?🤔

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:


Issue Report Process 📌

  1. Go to the project's issues.
  2. Give proper description for the issues.
  3. Don't spam to get the assignment of the issue 😀.
  4. Wait for till someone is looking into it !.
  5. Start working on issue only after you got assigned that issue 🚀.

If you'd like to contribute to this project, follow the steps

  1. 🌿Branch Out: Create a new branch with a meaningful name. Branching allows you to work on a separate line of development without affecting the main codebase.
$ git checkout -b <your_branch_name>
  1. ✍️Make Changes: Work your magic on the codebase. Modify existing files, add new ones, or remove unnecessary ones as needed.
  2. 📁Track Changes: After making your modifications, add the changed files to the staging area. 
    $ git add .
  3. 🚚Commit: Commit your changes with a descriptive message that summarizes the changes you've made. 
    $ git commit -m "<commit message>"
  4. 🚀Push Changes: Push your committed changes to your forked repository on GitHub. This will allow you to create a pull request from your branch. 
    $ git push -u origin <your_branch_name>
  5. 🌐Create Pull Request: Head to GitHub, navigate to your forked repository, and initiate a pull request by clicking "Compare & pull request".

Pull Request Process 🚀

  1. Ensure that you have self reviewed your code 😀
  2. Make sure you have added the proper description for the functionality of the code
  3. I have commented my code, particularly in hard-to-understand areas.
  4. Add screenshot it help in review.
  5. Submit your PR by giving the necesarry information in PR template and hang tight we will review it really soon 🚀

Thank you for contributing💗