Black Python Devs is an online-first community for Python devlopers who identify as Black.
Extending the ecosystem of Python Communities to Black and Colo(u)red Communities around the world.
This repo is the GitHub Pages website, built in Jekyll.
Please read Contributing to Black Python Devs
Follow these steps and note these guidelines to begin contributing:
- First step is to set up the local development environment.
- Bug fixes are always welcome. Start by reviewing the list of bugs.
- A good way to easily start contributing is to pick and work on a good first issue. 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.
-
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.
-
Click on the issues tab in the repository.
-
Click on the green button with the label "New issue" and you should see the image below:
-
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.
-
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.
-
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 and test them is by using
-
You can also access the Codespaces from the repository main page:
-
The web version of VSCode should open in a new tab in your browser:
-
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. -
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:
-
In the terminal run the command
bundle install.
-
After installing the dependencies, its time to run the application. We do this by running the command
bundle exec jekyll serveor run the default Build Task Ctrl + Shift + B:
-
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:
-
Ctrl + Click on the Forwarded Address assigned to Port 4000. This will open the running application in a new tab:
-
Test your changes (create new tests as needed)
-
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. 🥳
You can deploy your project locally but the fastest way to contribute is to use our Codespace.
