sahaba-ai / awesome-arabic-speakers

A curated and collaborative list of awesome Arabic speaker's contributions in tech regardless of their ethnicity, nationality, or location.
https://awesome-arabic-speakers.dev
MIT License
83 stars 26 forks source link

added: initial contribution guidelines #3

Closed majidzeno closed 1 month ago

majidzeno commented 1 month ago

πŸ“ Description

This PR updates the README file to reference the new CONTRIBUTING.md file and provides a comprehensive guide for contributors.

πŸ—οΈ Changes

πŸ”₯ Motivation and Context

Help new users and contributors quickly understand how to set up the project and make contributions.

πŸ§ͺ How to Test

  1. Clone the repository.
  2. Follow the steps in the updated CONTRIBUTING.md to set up the project locally.
  3. Verify that the Hugo server runs correctly and the site is accessible at http://localhost:1313.
  4. Ensure that the contribution instructions are clear and complete.

πŸ“‹ Checklist

aabouzaid commented 1 month ago

@majidzeno thanks for your addition :raised_hands: Please rebase to the main branch, then add the new parts to CONTRIBUTING.md and reference that file in the main readme file under the Contribution section.

aabouzaid commented 1 month ago

Thanks @majidzeno :raised_hands: