Skip to content

Commit d8f16b8

Browse files
committed
Add steps for running tests and linters/formatters
1 parent e24f6db commit d8f16b8

File tree

6 files changed

+27
-3
lines changed

6 files changed

+27
-3
lines changed

README.md

Lines changed: 27 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ Follow these steps and note these guidelines to begin contributing:
7878

7979
![Pre-commit install terminal](/assets/images/pre-commit_install_terminal.png)
8080

81-
- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
81+
- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve > /dev/null 2>&1 &` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
8282

8383
![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
8484

@@ -90,9 +90,33 @@ Follow these steps and note these guidelines to begin contributing:
9090

9191
![Running page](/assets/images/running_page.png)
9292

93-
### Testing Changes
93+
### Testing Changes (create new tests as needed)
9494

95-
- Test your changes (create new tests as needed)
95+
- To run the test suites for the codebase
96+
97+
- Ensure the site is running locally with `bundle exec jekyll serve > /dev/null 2>&1 &`. This will run the server in the background, and any content changes will immediately reflect on the site.
98+
99+
![Jekyll serve terminal](/assets/images/jekyll_server_start_terminal.png)
100+
101+
- If you need to restart the server, you can run `killall jekyll` to stop the server and then run `bundle exec jekyll serve > /dev/null 2>&1 &` to start the server again.
102+
103+
- Run all tests in the test-suite with the command `python3 -m pytest`:
104+
105+
![Pytest terminal](/assets/images/pytest_run_terminal.png)
106+
107+
### Pushing Changes
108+
109+
- Run `pre-commit run --all` to ensure your code is formatted and linted correctly before pushing your changes.
110+
111+
![Pre-commit run terminal](/assets/images/pre-commit_run_terminal.png)
112+
113+
- Run `git commit -m "<Your commit message>"` to commit your changes.
114+
115+
![Git commit terminal](/assets/images/git_commit_terminal.png)
116+
117+
- Finally run `git push origin <your-branch-name>` to push your changes to your fork.
118+
119+
![Git push terminal](/assets/images/git_push_terminal.png)
96120

97121
- Once you’ve committed and pushed all of your changes to GitHub, go to the page for your fork on GitHub, select your development branch, and click the pull request button. Please ensure that you compare your feature branch to the desired branch of the repo you are supposed to make a PR to. If you need to make any adjustments to your pull request, just push the updates to GitHub. Your pull request will automatically track the changes in your development branch and update it. 🥳
98122

assets/images/git_commit_terminal.png

66 KB
Loading

assets/images/git_push_terminal.png

59.1 KB
Loading
Loading
133 KB
Loading

assets/images/pytest_run_terminal.png

435 KB
Loading

0 commit comments

Comments
 (0)