search

chaoss / AFOS-AfricanOpenSource

AFOS (AfricanOpenSource) is a platform for showcasing Open Source projects build by Africans to increase visibility, and expose the projects to more contributors. This was a GitHub-funded project
https://www.africanopensource.com/
MIT License
19 stars 8 forks source link

Create the contributing guidelines #1

Closed CatherineKiiru closed 1 year ago

CatherineKiiru commented 1 year ago

The contributing guidelines should describe how to contribute to the project, how to write commits and how to create a PR.

Include the following details in the contributing.md file:

  1. How to run the project in a local environment
  2. List the tools required to run the project locally
  3. Describe how to install packages
  4. Describe how to create a new branch
  5. Describe how to run local host
  6. Describe how to commit changes and how to push them to GitHub

Here's a sample you can use for reference contributing guidelines

Kudzmat commented 1 year ago

Thanks, Catherine - I'm thinking that I can work on 1-3, and then Faith could do 4-6?

Other than GitHub Copilot itself, are there any other specific tools/packages required for running the project that I should know of or mention? Just want to make sure we're all on the same page and I don't go off doing my own thing!

CatherineKiiru commented 1 year ago

Hi @Kudzmat, yes you can work on the areas you prefer. Collaborate with Faith so that the guidelines are cohesive. The tools we'll use for the project are:

FaithKovi commented 1 year ago

@Kudzmat, we can collaborate on slack