Skip to content

Latest commit

 

History

History
44 lines (34 loc) · 1.19 KB

CONTRIBUTING.md

File metadata and controls

44 lines (34 loc) · 1.19 KB
Raw

Contributing

  1. Fork the repository

  2. Clone the repo to your local system

  git clone https://github.com/<your-user-name>/Project-SearchEverywhere.git
cd Project-SearchEverywhere
  1. Install dependencies
sudo chmod +x dependency.sh
sudo ./dependency.sh
  1. Make the source file executable
chmod +x src/SearchEverywhere.py
  1. Copy the src/ contents to testing_base/
  cp -R src/* testing_base/
 cd testing_base/
  1. Conduct tests using source file (SearchEverywhere.py) in testing_base directory, for example:
  ./SearchEverywhere.py - heading

  1. Create a new branch before making any changes to source file SearchEverywhere.py in src/

  2. Commit your final changes (bug fix/feature added etc.) in src/SearchEverywhere.py with an appopriate comment expaining the change.

  3. Create a pull request for src/SearchEverywhere.py script only.

  4. Thank You, your PR will be looked upon soon.

Kindly consider testing and debugging on a bunch of files of different file types(.txt, .odp, .odt, .pdf) to ensure that nothing is broken by the change made by you.