Skip to content

Latest commit

 

History

History
57 lines (37 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

57 lines (37 loc) · 1.19 KB
Raw

Contributing Guidelines

Getting Started

  1. Fork the repository on GitHub.

  2. Clone the forked repository to your local machine.

    git clone https://github.com/<your_github_username>/freeForGeeks.git

  3. Get into the root directory

    cd freeForGeeks

  4. Install docsify-cli globally, which helps initializing and previewing the website locally.

    npm i docsify-cli -g

  5. Create your branch

    git checkout -b <your_branch_name>

  6. Run the local server to preview the site in your browser.

    	docsify serve

  7. Go to http://localhost:3000 in your browser to see the site.

Making Changes

  1. Make sure your code follows the style guidelines of this project.

  2. Write clear, concise commit messages.

    git commit -m "✨ <commit message here>"

  3. Push to the branch.

git push origin <your_branch_name>
  1. Open a pull request.

Code of Conduct

Please note that this project is released with a Code of Conduct. By participating in this project you agree to abide by its terms.