Skip to content

CONTRIBUTING_GUIDELINES.md

Latest commit

 

History

History
78 lines (51 loc) · 3.26 KB

CONTRIBUTING_GUIDELINES.md

File metadata and controls

78 lines (51 loc) · 3.26 KB

🎇Contributing Guidelines

This documentation contains a set of guidelines to help you during the contribution process.

I'm happy to welcome all the contributions from anyone willing to add new scripts to this repository. Thank you for helping out and remember, no contribution is too small.

💻Before Contributing

Welcome to prathimacode-hub/Open-Source-Programs.

🙌Contribution

Any contribution is accepted. Please read this section if you are contributing your work.

🔖Steps to Contribute

Following are the steps to guide you:

  • Step 1: Fork the repo and Go to your Git terminal and clone it on your machine.
  • Step 2: Add a upstream link to main branch in your cloned repo 
    git remote add upstream https://github.com/prathimacode-hub/Open-Source-Programs.git
  • Step 3: Keep your cloned repo upto date by pulling from upstream (this will also avoid any merge conflicts while committing new changes) 
    git pull upstream main https://github.com/prathimacode-hub/Open-Source-Programs.git
  • Step 4: Create your feature branch (This is a necessary step, so don't skip it) 
    git checkout -b <feature-name>
  • Step 5: Commit all the changes (Write commit message as "Small Message") 
    git commit -m "Write a meaningfull but small commit message"
  • Step 6: Push the changes for review 
    git push origin <branch-name>
  • Step 7: Create a PR on Github. (Don't just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing)

🔨Note:

  • Do not edit/delete someone else's addons in this repository. You can only insert your data in this repository.
  • For any queries or discussions, please feel free to drop a message.

📖Resources

  1. Markdown : Markdown is a lightweight markup language like HTML, with plain text formatting syntax.
  1. Git : Git is a distributed version-control system for tracking changes in source code during software development. It is designed for coordinating work among programmers, but it can be used to track changes in any set of files.

🤔Need more help?

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

😇Tip from me

It always takes time to understand and learn. So, do not worry at all. I know you can do this**!💪

🎉 🎊 😃 Happy Contributing 😃 🎊 🎉