Skip to content

Latest commit

 

History

History
93 lines (73 loc) · 3.56 KB

CONTRIBUTING.md

File metadata and controls

93 lines (73 loc) · 3.56 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.

💥Steps to Contribute:

  1. Fork the repository to your own GitHub account.

  2. Clone the repository to your local machine

   $ git clone "https://www.github.com/{Username}/HelloWorld_Firstname.git"

where username is your GitHub account username.

  1. Create a branch where you can do your local work. Never work on master branch as we do not allow master commits except by admins.
   $ git branch {branchname}

   $ git checkout branchname
  1. Do your work and stage your changes.
   $ git add <filename>
  1. Commit you changes with a commit message containing your name, file(s) worked upon, changes added.
   $ git commit -m "Name| files| Changes"
  1. Push changes to your forked repository
   $ git push -u origin branchname
  1. Create a pull request to the upstream repository.

📜Synchronize forked repository with Upstream repository

  1. Create upstream as our repository
   $ git remote add upstream "https://www.github.com/prathimacode-hub/HelloWorld"
  1. Fetch upstream changes in local machine
   $ git fetch upstream
  1. Switch to master branch
   $ git checkout master
  1. Merge changes in local machine
   $ git merge upstream/master
  1. Push changes to your forked GitHub repository
   $ git push -f origin master

Note:

  • Do not edit/delete someone else's code in this repository. You can only insert new files/folder in this repository.
  • Give a meaningful name to file you are adding, for e.g., if you have written a Hello World code on Python, then HelloWorld_FirstName.py is one example of valid name.
  • Your program should follow this template.

What should I keep in mind while contributing?

  • When you are contributing, make sure that the work is entirely your own and not from some other source.

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 have got this!💪