Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
pedrobiqua authored Dec 31, 2024
1 parent 43a8758 commit 368b40e
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,14 @@ git commit -m "Add keyword search functionality
- Improve indexing performance for large data sets"
```

To maintain the commit standard, use Commitizen. To do so, simply install the dependencies using Poetry, where the entire project is built and tested. Follow the steps outlined in the Commitizen Getting Started Guide.
Example using Commitizen:
```bash
git add . # It is not recommended to use git add . This is just an example.
cz commit # Follow the instructions provided by cz.
```


### 5. Keep Your Fork Synchronized

Regularly update your fork with changes from the main repository:
Expand All @@ -59,7 +67,11 @@ git merge upstream/main
Ensure that your contribution does not break anything. Run the unit tests before submitting your pull request:

```bash
make test
mkdir build
cd build
cmake ..
make
./tests/unit-tests/LibUnitTests
```

If necessary, add new tests covering your functionality or fix.
Expand Down

0 comments on commit 368b40e

Please sign in to comment.