Skip to content

Latest commit

 

History

History
48 lines (34 loc) · 1.67 KB

File metadata and controls

48 lines (34 loc) · 1.67 KB

Contributor's Guide

You can contribute in many ways: openning or participating of a issue, reporting a bug, sending a pull request.

Getting Started

  1. Fork the project on Github, Help Guide to Fork a repository.

  2. Clone the project.

  3. Create a branch specific to the issue you are working on.

    git checkout -b update-readme-file
  4. Open up the project in your favourite text editor, select the file you want to contribute to and make your changes.

  5. After making your changes in the new git branch then add your modified files to git, How to add, commit, push and go

    git add path/to/filename.ext

    You can also add all unstaged files using:

    git add .

    Note, using a git add . will automatically add all files. You can do a git status to see your changes, but do it before git add.

  6. Commit your changes using a descriptive commit message.

    git commit -m "Brief Description of Commit"
  7. Push your commits to your Github Fork:

    git push -u origin branch-name
  8. Submit a pull request.

Submitting a Pull Request

Open your pull request, if you don't know how do it, check this tutorial

Code Style

For the good manutance of the project, follow all the code styles: