Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

46 lines (32 loc) · 1.29 KB

The Ultimate Contributing Guide

We use jekyll so you should follow their installation guide at jekyll

Prerequisites:

  1. Install Ruby.
  2. Install bundle.
  3. Install Jekyll.

Behavior

Please be nice to everyone this is the must important thing. be nice

Command lines you should know

Compiling

Use the command line below to compile your program and see results on live

bundle exec jekyll serve --livereload

Installing dependencies

Use the command line below to install the program's dependencies

bundle install

This is how you should contribute

  1. Make sure prerequisites are completed.
  2. Fork the repository.
  3. Clone your fork repository on your local machine.
  4. Open the project in the terminal
  5. Run bundle install to install dependencies.
  6. Run pre-commit install to set pre-commit.
  7. Create your changes branch.
  8. Make your changes.
  9. Run the site locally with bundle exec jekyll serve.
  10. Preview adawat site on your web browser by navigate to http://127.0.0.1:4000/adawat/.
  11. Commit and push the changes to your fork repository.
  12. Open a pull request of your changes.