Skip to content

Files

Latest commit

 

History

History
110 lines (77 loc) · 4.5 KB

CONTRIBUTING.md

File metadata and controls

110 lines (77 loc) · 4.5 KB

Contributing

Thank you for your interest in contributing to the Awesome Arabic Speakers project. We appreciate your efforts and contributions.

Inclusion Criteria

Awesome Arabic Speakers is an awesome list. Awesome lists are curated of the best, not everything.

So, we define the criteria for contributions per category as follows (we probably will change it a bit over time):

  • Project (like organization or community): It should be established for at least a year and has a clear impact.
  • Software (like code): It should have between 100 and 200 stars on GitHub (or equivalent on other platforms).
  • Event (like conference): It should be conducted at least 2 times if it's yearly, 4 times if it's quarterly, and 8 times if it's monthly.
  • Multimedia (like podcast, vodcast. or video tutorials): It should have around 10K subscribers.
  • Text (like blog): It should be live for over a year and has at least 12 posts.

Some exceptions may be allowed, but only in the narrowest limits (e.g., when the project is unique).

Exclusion Criteria

  • Contributions, not people: If the name hadn't already been so long, we would have named the project "Awesome Arabic Speakers Contributions." So, in this project, we don't evaluate the people but their contributions. Following that rule, we focus on the added value of the contribution and don't add personal details.
  • Only Awesome Contributions:: Awesome lists are curated of the best, not everything. Our top focus is on the unique contributions and avoiding redundant contributions.
  • No Non-Tech Resources: This project is interested solely in tech contributions. For the same reason, we don't add personal resources like channels and blogs with author names, as it could include tech and non-tech resources.

Running the Project Locally

To run this project locally, follow the next steps.

Prerequisites

Make sure you have the following installed on your machine:

  • Hugo (extended edition v0.129.0 or later)
  • Git

Steps

  1. Clone the repository:

    git clone https://github.com/sahaba-ai/awesome-arabic-speakers.git
cd awesome-arabic-speakers

  2. Install dependencies:

    hugo mod get

  3. Run the Hugo server:

    hugo server

  4. Open your browser: Open your browser and go to http://localhost:1313 to see the site running locally.

  5. Reflect changes locally: To build the project locally and see the changes, you need to run the Hugo server with the draft content enabled:

    hugo server -D

How to Contribute

We welcome contributions from everyone. The list covers many categories like Entity, Software, Multimedia, Text, and Event. For more details, check the criteria for each section.

Steps to Contribute

  1. Fork the repository: Click the "Fork" button at the top-right corner of this page to create a copy of this repository under your GitHub account.

  2. Clone your fork:

    git clone https://github.com/<your-username>/awesome-arabic-speakers.git
cd awesome-arabic-speakers

  3. Create a new branch:

    git checkout -b feature/your-feature-name

  4. Make your changes: Add your contributions (e.g., new categories, links, or improvements).

  5. Commit your changes: We use the Keep a Changelog commit message convention.

    git add .
git commit -m "added: add new feature"

  6. Push to your fork:

    git push origin feature/your-feature-name

  7. Create a pull request: Go to the original repository on GitHub and create a new pull request from your fork.

Contribution Guidelines

  • Follow the existing code style and structure.
  • Ensure that your contributions are well-documented.
  • Test your changes to make sure they work as expected.

License

The project code is licensed under the MIT License. The project content is licensed under CC BY-SA 4.0.