You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+1-109
Original file line number
Diff line number
Diff line change
@@ -12,114 +12,6 @@ This repo is the [GitHub Pages](https://pages.github.com/) website, built in Jek
12
12
13
13
Please read [Contributing to Black Python Devs](CONTRIBUTING.md)
14
14
15
-
Follow these steps and note these guidelines to begin contributing:
16
-
17
-
1. First step is to set up the local development environment.
18
-
1. Bug fixes are always welcome. Start by reviewing the [list of bugs](https://github.com/BlackPythonDevs/blackpythondevs.github.io/issues).
19
-
1. A good way to easily start contributing is to pick and work on a [good first issue](https://github.com/BlackPythonDevs/blackpythondevs.github.io/labels/good%20first%20issue). We try to make these issues as clear as possible and provide basic info on how the code should be changed, and if something is unclear feel free to ask for more information on the issue.
20
-
21
-
# How to Contribute
22
-
23
-
## Fork the repository
24
-
25
-
- To fork the repository so you have a copy of the codebase, you will click on the **"Fork"** button from the repository main page
- Clicking on the Fork button takes you to the **"Create New Fork"** page where you select the owner (your personal github account) and click on the Create fork button.
30
-
31
-

32
-
33
-
## Creating an issue
34
-
35
-
- Click on the issues tab in the repository.
36
-
37
-

38
-
39
-
- Click on the green button with the label **"New issue"** and you should see the image below:
40
-
41
-

42
-
43
-
- Type in the issue title in the title textbox and type in a clear explanation of the issue in the textarea. You can add images, code snippets, etc to explain your issue.
44
-
45
-
- Once you are done, you can preview your issue by selecting the Preview tab. If you are satisfied with the issue presentation, you can click on the green "Submit new issue" button to create your issue.
46
-
47
-
- And that's it! If you cose to comment requesting the issue to be assigned to you, wait for a maintainer to do so. You should get an email notification of the issue being assigned to you or you can view the issue assignment in the issue page. It should look similar to this:
- The easiest way to make changes and test them is by using [](https://codespaces.new/BlackPythonDevs/blackpythondevs.github.io)
54
-
55
-
- You can also access the Codespaces from the repository main page:
- Now that you have the code editor set up, you need to install the dependencies. To do this, you have to open the code editor's terminal and run the command `bundle install`.
64
-
65
-
- The easiest way to open the terminal is to click on the 3 horizontal lines (also known as hamburger) at the top left of the code editor > Terminal > New Terminal:
- 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>:
- The server address shows `http://127.0.0.1:4000`. This is the address for any local computer so this server will be wrong since the application is running on a remote computer so we have to get the address of that computer. We can get the address by clicking on the Ports tab next to the Terminal:
- <kbd>Ctrl</kbd> + Click on the Forwarded Address assigned to Port 4000. This will open the running application in a new tab:
90
-
91
-

92
-
93
-
### Testing Changes (create new tests as needed)
94
-
95
-
- To run the test suites for the codebase
96
-
97
-
- 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.
- If you need to restart the server, you can run `killall jekyll` to stop the server and then run `bundle exec jekyll serve --detach` to start the server again.
102
-
103
-
- Run all tests in the test-suite with the command `python3 -m pytest`:
- 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. 🥳
122
-
123
15
## To Develop
124
16
125
17
[](https://codespaces.new/BlackPythonDevs/blackpythondevs.github.io)
@@ -262,4 +154,4 @@ You can deploy your project locally but the fastest way to contribute is to use
0 commit comments