Code Monkey home page Code Monkey logo

blackpythondevs.github.io's Introduction

blackpythondevs.github.io

Black Python Devs is an online-first community for Python devlopers who identify as Black.

This repo is the GitHub Pages website, built in Jekyll.

Contributing to Black Python Devs Projects

Please read Contributing to Black Python Devs

Follow these steps and note these guidelines to begin contributing:

  1. First step is to set up the local development environment.
  2. Bug fixes are always welcome. Start by reviewing the list of bugs.
  3. 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.

How to Contribute

Fork the repository

  • To fork the repository so you have a copy of the codebase, you will click on the "Fork" button from the repository main page

    Fork button

  • 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.

    Create new fork page

Creating an issue

  • Click on the issues tab in the repository.

    issues tab

  • Click on the green button with the label "New issue" and you should see the image below:

    New issue button

  • 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:

    issue assignment

Working on an issue

  • The easiest way to make changes and and test them is by using GitHub Codespaces

  • You can also access the Codespaces from the repository main page:

    Codespaces tab

  • The web version of VSCode should open in a new tab in your browser:

    Black Python Devs Codespace

  • 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:

    Terminal starter

  • In the terminal run the command bundle install.

    Bundle install terminal

  • 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 Ctrl + Shift + B:

    Jekyll serve terminal

  • 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:

    Codespace ports

  • Ctrl + Click on the Forwarded Address assigned to Port 4000. This will open the running application in a new tab:

    Running page

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

To Develop

Open in GitHub Codespaces

Open in Gitpod

You can deploy your project locally but the fastest way to contribute is to use our Codespace.

Contributors

oleksis
Oleksis Fraga Menéndez
kjaymiller
Jay Miller
ooduor
Antony Oduor
kazz54
Null
shaswat-satyam
Shaswat Satyam
bilesanmiahmad
Bilesanmi Ahmad
mannyanebi
Emmanuel Anebi
zablon-oigo
Zablon
VeldaKiara
Velda Kiara
sandramsc
Sandra Ashipala
Fahass
Umar Farouk
dragid10
Alex Oladele
tim-schilling
Tim Schilling
ankitgadling
Null

blackpythondevs.github.io's People

Contributors

oleksis avatar kjaymiller avatar github-actions[bot] avatar ooduor avatar actions-user avatar kazz54 avatar shaswat-satyam avatar veldakiara avatar zablon-oigo avatar mannyanebi avatar bilesanmiahmad avatar anoexpected avatar dragid10 avatar sandramsc avatar fahass avatar tim-schilling avatar ankitgadling avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.