From 7f5437db80c3b2ebfa35a8eec3e8349deb08bf32 Mon Sep 17 00:00:00 2001 From: Gabriel Bronzatti Moro Date: Thu, 22 Jan 2026 16:24:47 -0300 Subject: [PATCH 1/2] Add contribution guide to CONTRIBUTING.md Added a contribution guide outlining the steps for contributing to the project. --- CONTRIBUTING.md | 42 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c65b03d --- /dev/null +++ b/CONTRIBUTING.md @@ -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. + +--- + + From ddeaf66dd94b2d9a24158e86ea6b2b8ef1befe3f Mon Sep 17 00:00:00 2001 From: Gabriel Moro Date: Thu, 22 Jan 2026 16:29:41 -0300 Subject: [PATCH 2/2] Update documentation to include contributing instructions --- doc/3-contributions.md | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) diff --git a/doc/3-contributions.md b/doc/3-contributions.md index 80fa36c..c996eb3 100644 --- a/doc/3-contributions.md +++ b/doc/3-contributions.md @@ -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! \ No newline at end of file