Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
## Contribution Guide

### 1. Fork the repository

Create a fork of the repository in your own GitHub account.

### 2. Clone the repository

```bash
git clone https://github.com/your-user/your-fork
```

### 3. Access the repository

```bash
cd your-fork
```

### 4. Make your changes

- Update the code.

### 5. Commit the changes to your fork

```bash
git checkout -b "your-branch-name"
git add .
git commit -m "Describe your changes"
git push
```

### 6. Create your Pull Request

- Create a new Pull Request, selecting the original repository as the base and your branch as the compare branch

- Provide a clear title and a detailed description of your changes

- Submit the PR and wait for review and possible approval.

---


41 changes: 41 additions & 0 deletions doc/3-contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,45 @@ We encourage contributions of all types! Whether it's reporting issues, suggesti

- Feel free to submit [pull requests](https://github.com/CodandoTV/eagle-eye/pulls).

## Contribution Guide 📚

### 1. Fork the repository

Create a fork of the repository in your own GitHub account.

### 2. Clone the repository

```bash
git clone https://github.com/your-user/your-fork
```

### 3. Access the repository

```bash
cd your-fork
```

### 4. Make your changes

- Update the code.

### 5. Commit the changes to your fork

```bash
git checkout -b "your-branch-name"
git add .
git commit -m "Describe your changes"
git push
```

### 6. Create your Pull Request

- Create a new Pull Request, selecting the original repository as the base and your branch as the compare branch

- Provide a clear title and a detailed description of your changes

- Submit the PR and wait for review and possible approval.

---

🤗 Happy coding!