Skip to content

Latest commit

 

History

History
63 lines (52 loc) · 1.79 KB

Contributing.md

File metadata and controls

63 lines (52 loc) · 1.79 KB

How Can I Contribute?

Don't know how to start of open source and Contribute to our Open Source Project ? Welcome to the world of hacking!

The steps to follow to contribute to any projects:

  1. Install git

    If you don't have git on your machine, install it.

  2. Fork this repository

    Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

  3. Clone the repository

    Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

    Open a terminal and run the following git command:

    git clone "url you just copied"
    
  4. Move to the folder

    cd roxo-hugo
    
  5. Add a upstream link to main branch in your cloned repo

    git remote add upstream <original repository>
    
  6. Keep your cloned repo upto date by pulling from upstream

    This will also avoid any merge conflicts while committing new changes

    git pull upstream master
    
  7. Create your feature branch

    Always create new branch

    git checkout -b <feature-name>
    
  8. Track your changes

    git add .
    ```.
    
  9. Check for your changes.

    git status
    
  10. Commit all the changes

    Write commit message as "Small Message"

    git commit -m "Write a meaningfull but small commit message"
    
  11. Push the changes for review

    git push origin <branch-name>
    
  12. Create a PR on Github.

    Just hit the create a pull request button, you must write a PR message to clarify why and what are you contributing