Skip to content

Commit

Permalink
docs(contributing): add additional resources for prerequisites
Browse files Browse the repository at this point in the history
  • Loading branch information
thegbk committed Jan 29, 2025
1 parent 1156300 commit d8f0605
Showing 1 changed file with 17 additions and 10 deletions.
27 changes: 17 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,18 @@

## **Prerequisites**

- You have a GitHub account
- A local Hugo installation
- Pre-commit and Commitizen installed
- A basic understanding of Markdown and HTML
- [ ] A local Git setup configured to [sign commits](https://docs.github.com/en/authentication/managing-commit-signature-verification/signing-commits)
- [ ] A local [Hugo](https://gohugo.io/installation/) installation
- [ ] Latest version of [Pre-commit](https://pre-commit.com/#install) and [Commitizen](https://commitizen-tools.github.io/commitizen/) installed
- [ ] A basic understanding of Markdown and HTML

## **Step 1: Clone the Repository**

- Navigate to your terminal and run the following command to clone the repository:

```
```bash
git clone https://github.com/jordanopensource/policies.ost.josa.ngo.git
pre-commit install
```

> Note: Make sure you use the correct fork URL if you are using a fork workflow.
Expand All @@ -21,7 +22,7 @@ git clone https://github.com/jordanopensource/policies.ost.josa.ngo.git

- Navigate to your cloned repository and create a new branch using the following command:

```
```bash
git checkout -b task/my-new-branch
```

Expand All @@ -32,7 +33,7 @@ Replace `task/my-new-branch` with a descriptive name for your branch. We recomme
- Create a new Markdown file or edit an existing one in the `content` directory.
- Use the following file structure:

```
```bash
content/
└── another-page/
├── index.md # Base localization (English)
Expand All @@ -46,13 +47,19 @@ This will generate a route `/another-page/` localized into English and Arabic. C

- Make sure to add your changes to the staging area using the following command:

```
git add .
```bash
git add another-page/
```

- Commit your changes using the following command:

```bash
cz c
```

- or manually by running the following command:

```bash
git commit -m "Your commit message"
```

Expand All @@ -62,7 +69,7 @@ Replace `Your commit message` with a descriptive message for your commit. We rec

- Push your changes to the repository using the following command:

```
```bash
git push origin new-branch-name
```

Expand Down

0 comments on commit d8f0605

Please sign in to comment.