readme and contributing changes

.github/ISSUE_TEMPLATE/bug_report.md

@@ -23,8 +23,8 @@ A clear and concise description of what you expected to happen.
 
 **Desktop (please complete the following information):**
  - OS: [e.g. Windows, macOS]
- - Version of stellapy you are using [e.g. v0.1.0] (check it using stella -v)
- - Stella configuration (located in `~/stella_config.json`)
+ - Version of stellapy you are using [e.g. v0.1.0] (check it using `stella -v`)
+ - Stella configuration (located in `stella.yml`)
 
 **Additional context**
 Add any other context about the problem here.

CONTRIBUTING.md

@@ -5,44 +5,16 @@
 The following is a set of guidelines for contributing to *stella*, which is hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
 
 
-## Project Structure
-```
-├── .github
-|  ├── ISSUE_TEMPLATE
-|  |  ├── bug_report.md
-|  |  ├── config.yml
-|  |  ├── custom.md
-|  |  └── feature_request.md
-|  └── workflows
-|     └── python-package.yml
-├── .gitignore
-├── CHANGELOG.md
-├── CONTRIBUTING.md
-├── LICENSE
-├── README.md
-├── assets
-├── requirements.txt
-├── setup.py
-├── stellapy
-|  ├── __init__.py
-|  ├── configuration.py
-|  ├── executor.py
-|  ├── logger.py
-|  ├── reloader.py
-|  ├── stella.py
-|  └── walker.py
-```
-
 ## Setup Development Environment
 This section shows how you can setup your development environment to contribute to stella.
 
 - Fork the repository.
-- Clone it using Git (`git clone https://github.com/<YOUR USERNAME>stella.git`).
+- Clone it using Git (`git clone https://github.com/<YOUR USERNAME>/stella.git`).
 - Create a new git branch (`git checkout -b "BRANCH NAME"`).
 - Execute `pip install -e .` to install all the dependencies and make an editable install.
 - Make changes.
 - Stage and commit (`git add .` and `git commit -m "COMMIT MESSAGE"`).
-- Push it your remote repository (`git push`).
+- Push it to your remote repository (`git push`).
 - Open a pull request by clicking [here](https://github.com/shravanasati/stellapy/compare).
 
 

README.md

@@ -78,7 +78,6 @@ browser: firefox
 include_only: []
 poll_interval: 500
 browser_wait_interval: 1000
-follow_symlinks: false
 scripts:
 - name: default
   url: ''
@@ -108,7 +107,7 @@ Let's quickly go over the config options:
 
     * `url`: The URL to listen to on the browser. Set it to an empty string (`''`) if you don't want live reload on the browser. eg. `localhost:8000`.
 
-      > Note: For chrome and edge, you URLs starting with `localhost` won't work, prepend the `url` with a scheme like `http://` or `file://`. Not tested on safari, but if you see `data;` in the address bar, this URL change should fix it.
+      > Note: For chrome and edge, URLs starting with `localhost` won't work, prepend the `url` with a scheme like `http://` or `file://`. Not tested on safari, but if you see `data;` in the address bar, this URL change should fix it.
 
     * `command`: A single command or a list of commands to execute on the terminal. eg.
       ```
@@ -121,7 +120,7 @@ Let's quickly go over the config options:
         - go build
         - ./main.exe
       ```
-      If a list of commands are provided, the `shell` will be considered `true` even if it's `false`.
+      If a list of commands are provided, the `shell` will be considered `true` even if it's `false`, and these commands will be executed **sequentially** one after the other.
 
     * `shell`: **Boolean** value which indicates whether to execute commands inside a shell context (like bash, powershell, zsh...) or as an independent process. This is useful if you want to execute shell scripts directly without invoking the shell interpreter. On Windows, powershell is used as shell (instead of cmd). On Linux and MacOS, the shell used is determined by `SHELL` environment variable. If it's not present, `/bin/sh` will be used.
 
@@ -168,7 +167,7 @@ If an error is encountered on refreshing the browser page (an event which can ha
 
 License © 2021-Present Shravan Asati
 
-This repository is licensed under the MIT license. See [LICENSE](LICENSE) for details.
+This repository is licensed under the MIT license. See [LICENSE](LICENSE.txt) for details.
 
 <br>
 

stellapy/walker.py

@@ -12,6 +12,7 @@
 
 
 def get_ignore_include_patterns(include_only: Iterable[str] | None):
+    # todo use stella.ignore and .gitignore together
     ignore_filepath = find_ignore_file()
     ignore_match = (
         gitignorefile.parse(ignore_filepath) if ignore_filepath else lambda _: False