Skip to content

Commit 130961d

Browse files
TimOsahenruTimOsahenru
authored
Merge branch 'BlackPythonDevs:gh-pages' into update-maintainers-and-contributors-file-for-overassigning-issues
2 parents b8de6f5 + 7bc8db1 commit 130961d

15 files changed

+137
-20
lines changed

‎.github/ISSUE_TEMPLATE/add_conference.yml

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name: Add Conference
22
description: Add Conference dates, location, speaking and other information that you would like shared
33
title: "[CONFERENCE] <CONFERENCE NAME> YYYY"
4-
labels: ["conference"]
4+
labels: ["conference", "CFP"]
55
body:
66
- type: input
77
id: conference_name
@@ -40,6 +40,22 @@ body:
4040
placeholder: "CITY, <REGION>, COUNTRY"
4141
validations:
4242
required: false
43+
- type: input
44+
id: cfp_link
45+
attributes:
46+
label: CFP Link
47+
description: Provide the URL for the Call for Proposals (CFP) (make sure to include `https://`).
48+
placeholder: "https://example.com/cfp"
49+
validations:
50+
required: true
51+
- type: input
52+
id: cfp_deadline
53+
attributes:
54+
label: CFP Deadline
55+
description: Enter the deadline for submitting CFPs (YYYY-MM-DD).
56+
placeholder: "YYYY-MM-DD"
57+
validations:
58+
required: true
4359
- type: textarea
4460
id: conference_description
4561
attributes:

‎.github/workflows/conference.yml

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -55,19 +55,19 @@ jobs:
5555
automated pr
5656
add_comment:
5757
runs-on: ubuntu-latest
58-
58+
5959
steps:
60-
- name: Add comment to the issue
61-
uses: actions/github-script@v6
62-
if: ${{ github.event.issue.user.type != 'User' }} #adds comment only if the issue is created by a bot
63-
with:
64-
github-token: ${{ secrets.GITHUB_TOKEN }}
65-
script: |
66-
const issueNumber = context.payload.issue.number;
67-
const comment = "Automated issue, no action is required."
68-
69-
github.issues.createComment({
70-
...context.repo,
71-
issue_number: issueNumber,
72-
body: comment
73-
});
60+
- name: Add comment to the issue
61+
uses: actions/github-script@v6
62+
if: ${{ github.event.issue.user.type != 'User' }} #adds comment only if the issue is created by a bot
63+
with:
64+
github-token: ${{ secrets.GITHUB_TOKEN }}
65+
script: |
66+
const issueNumber = context.payload.issue.number;
67+
const comment = "Automated issue, no action is required."
68+
69+
github.issues.createComment({
70+
...context.repo,
71+
issue_number: issueNumber,
72+
body: comment
73+
});

‎.github/workflows/playwright.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ on:
1313

1414
jobs:
1515
test:
16+
timeout-minutes: 30
1617
runs-on: ubuntu-latest
1718
steps:
1819
- uses: actions/checkout@v3

‎CONTRIBUTING.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,15 @@ Follow these steps and note these guidelines to begin contributing:
6060

6161
![Bundle install terminal](/assets/images/bundle_install_terminal.png)
6262

63-
- 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>:
63+
- Afterwards, run the command `pip install -r requirements-dev.txt` to install the python dev dependencies.
64+
65+
![Pip install terminal](/assets/images/pip_install_terminal.png)
66+
67+
- Install the pre-commit hooks to automatically format the code before committing. Run the command `pre-commit install`:
68+
69+
![Pre-commit install terminal](/assets/images/pre-commit_install_terminal.png)
70+
71+
- After installing the dependencies, its time to run the application. We do this by running the command `bundle exec jekyll serve --detach` or run the default **Build Task** <kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>B</kbd>:
6472

6573
![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
6674

@@ -72,6 +80,32 @@ Follow these steps and note these guidelines to begin contributing:
7280

7381
![Running page](/assets/images/running_page.png)
7482

75-
- Test your changes (create new tests as needed)
83+
### Testing Changes (create new tests as needed)
84+
85+
- To run the test suites for the codebase
86+
87+
- Ensure the site is running locally with `bundle exec jekyll serve --detach`. This will run the server in the background, and any content changes will immediately reflect on the site.
88+
89+
![Jekyll serve terminal](/assets/images/jekyll_serve_terminal.png)
90+
91+
- If you need to restart the server, you can run `pkill -f jekyll` to stop the server and then run `bundle exec jekyll serve --detach` to start the server again.
92+
93+
- Run all tests in the test-suite with the command `python3 -m pytest`:
94+
95+
![Pytest terminal](/assets/images/pytest_run_terminal.png)
96+
97+
### Pushing Changes
98+
99+
- Run `pre-commit run --all` to ensure your code is formatted and linted correctly before pushing your changes.
100+
101+
![Pre-commit run terminal](/assets/images/pre-commit_run_terminal.png)
102+
103+
- Run `git commit -m "<Your commit message>"` to commit your changes.
104+
105+
![Git commit terminal](/assets/images/git_commit_terminal.png)
106+
107+
- Finally run `git push origin <your-branch-name>` to push your changes to your fork.
108+
109+
![Git push terminal](/assets/images/git_push_terminal.png)
76110

77111
- 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. 🥳

‎_data/books.json

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[
2+
{
3+
"title": "Boost Your Django DX",
4+
"author": "Adam Johnson",
5+
"url": "https://adamchainz.gumroad.com/l/byddx",
6+
"reviews": [
7+
{
8+
"title": "Review: Boost Your Django DX by Adam Johnson",
9+
"author": "Velda Kiara",
10+
"url": "https://dev.to/veldakiara/review-boost-your-django-dx-by-adam-johnson-9ho"
11+
}
12+
]
13+
}
14+
]

‎_data/partnerships.yml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
- name: "TalkPython Training"
22
promo_code: "bpd-20pc-1c1da"
3-
description: "When you use the promo code: <strong>bpd-20pc-1c1da</strong> at checkout, you will receive 10% off your course purchase. TalkPython Training will also donate 20% of the purchase to Black Python Devs."
4-
url: "/2024-08-16-talkpython-training-partnership"
3+
description: 'When you use the <a href="https://training.talkpython.fm/black-python-devs">Black Python Devs landing page</a> or use the promo code: <strong>bpd-20pc-1c1da</strong> at checkout, you will receive 10% off your course purchase. TalkPython Training will also donate 20% of the purchase to Black Python Devs.'
4+
url: "https://training.talkpython.fm/black-python-devs"
55
logo: "/assets/images/talkpython.webp"
6+
67
- name: "O'Reilly Media"
78
promo_code: "https://oreillymedia.pxf.io/c/5713155/2126973/15173"
89
description: '<a href="https://oreillymedia.pxf.io/c/5713155/2126973/15173">Sign up with our promo code</a> to receive a 30-day trial of O''Reilly''s Learning Platform. If you sign up beyond the trial a percentage of your subscription will go to Black Python Devs.'

‎assets/images/git_commit_terminal.png

40.7 KB
Loading

‎assets/images/git_push_terminal.png

37.6 KB
Loading

‎assets/images/jekyll_serve_terminal.png

122 KB
Loading

‎assets/images/pip_install_terminal.png

51.3 KB
Loading

‎assets/images/pre-commit_install_terminal.png

54.9 KB
Loading

‎assets/images/pre-commit_run_terminal.png

105 KB
Loading

‎assets/images/pytest_run_terminal.png

242 KB
Loading

‎book-club.html

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
layout: default
3+
title: "Book Club Page"
4+
description: "This is the book club page"
5+
---
6+
7+
<section class="book-club">
8+
<h1><strong>Black Python Devs Book Club: A Community of Readers and Learners</strong></h1>
9+
<p>The Black Python Devs book club was born from the community's growing passion for technical reading and learning.</p>
10+
11+
<p>
12+
Our goal is to create a welcoming and supportive space where members can share their love of Python development, discuss industry trends, and dive deeper into technical concepts. By reading and discussing books together, we hope to sharpen our
13+
skills, connect with like-minded developers, and contribute to the growth of our community.
14+
</p>
15+
16+
<p>The club's leadership is dedicated to building a vibrant and engaging community for everyone. Our initiative aligns with BPD's overall mission to increase participation, empower our members, and provide opportunities for professional growth.</p>
17+
18+
<h3><strong>Books Completed:</strong></h3>
19+
20+
{% for book in site.data.books %}
21+
<div class="book">
22+
<h2>{{ book.title }}</h2>
23+
<p><strong>Author:</strong> {{ book.author }}</p>
24+
25+
<h4>Reviews</h4>
26+
{% if book.reviews %}
27+
<ul>
28+
{% for review in book.reviews %}
29+
<li><a href="{{ review.url }}" target="_blank">{{ review.title }}</a> by {{ review.author }}</li>
30+
{% endfor %}
31+
</ul>
32+
{% else %}
33+
<p><em>No reviews available.</em></p>
34+
{% endif %}
35+
</div>
36+
{% endfor %}
37+
38+
<h4>Upcoming Books</h4>
39+
<ul>
40+
{% for upcoming in site.data.upcoming_books %}
41+
<li>{{ upcoming.title }} by {{ upcoming.author }} ({{ upcoming.date }})</li>
42+
{% endfor %}
43+
</ul>
44+
45+
<h4>Join Today</h4>
46+
<p>Our Book club meets twice a month on <a href="https://discord.com/invite/XUc3tFqCT3">Discord</a>.</p>
47+
</section>
48+
49+
<hr />
50+
<p>Have a book suggestion? <a href="https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues/new?assignees=&labels=book&projects=&template=add_book.yml&title=%5BBOOK%5D+%3CBOOK+TITLE%3E+BY+AUTHOR">Submit a Suggestion</a></p>

‎tests/conftest.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ def url_port() -> tuple[str, int]:
1818
"events",
1919
"community",
2020
"leadership",
21+
"book-club",
2122
]
2223

2324

0 commit comments

Comments
 (0)