Skip to content

Commit e5fa18d

Browse files
committed
Add steps for ensuring pre-commit hooks are installed
1 parent 14a7f5a commit e5fa18d

File tree

3 files changed

+11
-1
lines changed

3 files changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ Follow these steps and note these guidelines to begin contributing:
5050

5151
## Working on an issue
5252

53-
- The easiest way to make changes and and test them is by using [![GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/BlackPythonDevs/blackpythondevs.github.io)
53+
- The easiest way to make changes and test them is by using [![GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/BlackPythonDevs/blackpythondevs.github.io)
5454

5555
- You can also access the Codespaces from the repository main page:
5656

@@ -70,6 +70,14 @@ Follow these steps and note these guidelines to begin contributing:
7070

7171
![Bundle install terminal](/assets/images/bundle_install_terminal.png)
7272

73+
- Afterwards, run the command `pip install -r requirements-dev.txt` to install the python dev dependencies.
74+
75+
![Pip install terminal](/assets/images/pip_install_terminal.png)
76+
77+
- Install the pre-commit hooks to automatically format the code before committing. Run the command `pre-commit install`:
78+
79+
![Pre-commit install terminal](/assets/images/pre-commit_install_terminal.png)
80+
7381
- 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>:
7482

7583
![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
@@ -82,6 +90,8 @@ Follow these steps and note these guidelines to begin contributing:
8290

8391
![Running page](/assets/images/running_page.png)
8492

93+
### Testing Changes
94+
8595
- Test your changes (create new tests as needed)
8696

8797
- 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. 🥳
58.8 KB
Loading
89.5 KB
Loading

0 commit comments

Comments
 (0)