Skip to content

Latest commit

 

History

History
138 lines (103 loc) · 2.97 KB

Contributing.md

File metadata and controls

138 lines (103 loc) · 2.97 KB

Contributing

Add a project by making a pull request

Please note we have a code of conduct, please follow it in all your interactions with the project. To contribute to this project directly send in a pull request. Here are some guidelines for this:

Guidelines

  1. The project should be an open source project. (Do well to have a well outlined contribution procedure to help others easily contribute)

  2. Verify that the project yet to be added does not already exist in the project list.

    • You can easily verify from the website by searching for the project name with additional filters if required.

    • Or open the projects.json and search through.

  3. Ensure that you are the rightful owner/author of the project yet to be added. If you are a contributor/maintainer or any other, ensure you have been permitted to share the projet on this platform.

  4. In projects.json, add a JSON entry of the project.

    • Your JSON entry should have :

      • Project name
      • URL to your Github project repository
      • Project description
      • Author/owner of the project
      • Author's country of origin (Must be African)
      • Author's Twitter account

    • Example of a JSON entry:

      {
    "name": "made-in-africa",
    "github_url": "https://github.com/by-africans/open-source-projects",
    "description": "A list of projects by Africans",
    "author": "by-africans",
    "author_country": "Ghana",
    "twitter": "https://twitter.com/by_africans"
}

Report bugs related to the website using Github's issues

We use GitHub issues to track public bugs related to byafricans.org . Report a bug by opening a new issue; it's that easy!

List of African countries

Below is a list of African countries. Do well to make reference to the list to add up to you JSON entry.

A

  • Algeria
  • Angola

B

  • Benin
  • Botswana
  • Burkina Faso
  • Burundi

C

  • Cabo Verde
  • Cameroon
  • Central African Republic (CAR)
  • Chad
  • Comoros
  • Congo, Democratic Republic of the
  • Congo, Republic of the
  • Cote d'Ivoire

D

  • Djibouti

E

  • Egypt
  • Equatorial Guinea
  • Eritrea
  • Swaziland
  • Ethiopia

G

  • Gabon
  • Gambia
  • Ghana
  • Guinea
  • Guinea-Bissau

K

  • Kenya

L

  • Lesotho
  • Liberia
  • Libya

M

  • Madagascar
  • Malawi
  • Mali
  • Mauritania
  • Mauritius
  • Morocco
  • Mozambique

N

  • Namibia
  • Niger
  • Nigeria

R

  • Rwanda

S

  • Sao Tome and Principe
  • Senegal
  • Seychelles
  • Sierra Leone
  • Somalia
  • South Africa
  • South Sudan
  • Sudan

T

  • Tanzania
  • Togo
  • Tunisia

U

  • Uganda

Z

  • Zambia
  • Zimbabwe

NOTE: Pull requests are usually reviewed within 24 hours. Once your pull request is merged, you should see your project on the site a few minutes after.