Skip to content

Coding styles, documentation and workflows#8

Merged
Tonidotpy merged 9 commits into
devfrom
refactor/coding-style
Mar 18, 2026
Merged

Coding styles, documentation and workflows#8
Tonidotpy merged 9 commits into
devfrom
refactor/coding-style

Conversation

@najirod02
Copy link
Copy Markdown
Contributor

Purpose

The library was originally developed using an outdated template and did not strictly adhere to current coding standards. This PR synchronizes the codebase with the latest library template and enforces current coding standards.

Overview

  • Applied the coding standards
  • Add pre-commit hook to apply formatter
  • Add Doxyfile for documentation generation
  • Add workflow to ensure code quality during commits and merging.

Guidance

None in particular.

@najirod02
Copy link
Copy Markdown
Contributor Author

Apologies for the noisy commit history. I ran into a few issues while preparing the PR and had to push some fixes.

@najirod02 najirod02 requested review from Bridiro and Tonidotpy March 14, 2026 16:33
@najirod02
Copy link
Copy Markdown
Contributor Author

If everything is ok, could you also merge the code into master and generate the new release?

@najirod02 najirod02 linked an issue Mar 14, 2026 that may be closed by this pull request
@Tonidotpy
Copy link
Copy Markdown
Member

Tonidotpy commented Mar 14, 2026

Please don't push commits after a review is required @najirod02.
Also @Bridiro, don't merge yet my review is in progress and there are changes that needs to be requested.

Copy link
Copy Markdown
Member

@Tonidotpy Tonidotpy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you remove the capacity related functionalities? The capacity is the maximum number of elements the buffer can hold while the size is the current number of elements inside the buffer at a given moment. (e.g. capacity = 10, size = 3 -> means that there are 3 items inside a buffer that can contain up to 10 items; if the size is equal to the capacity the buffer is full and cannot hold other items)

Comment thread library.json Outdated
Comment thread include/ring-buffer-api.h Outdated
Comment thread include/ring-buffer-api.h Outdated
Comment thread include/ring-buffer-api.h
Copy link
Copy Markdown
Contributor

@Bridiro Bridiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Except a few things (mainly documentation-related) seems to be working to me

Comment thread include/ring-buffer-api.h Outdated
Comment thread include/ring-buffer-api.h Outdated
Comment thread src/ring-buffer-api.c Outdated
@najirod02
Copy link
Copy Markdown
Contributor Author

Well, all these problems arose becasue I've made the branch starting from the main and not the dev...

@najirod02 najirod02 requested review from Bridiro and Tonidotpy March 18, 2026 10:01
Copy link
Copy Markdown
Member

@Tonidotpy Tonidotpy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll set the version to v0.2.0 rather than v0.3.0 since this branch has not yet been merged and the only version available by now is the v0.1.0.
Except this small change the rest is ok and the PR can be approved for me.

Comment thread Doxyfile Outdated
Comment thread library.json Outdated
najirod02 and others added 2 commits March 18, 2026 12:16
Co-authored-by: Antonio Gelain <61268285+Tonidotpy@users.noreply.github.com>
Co-authored-by: Antonio Gelain <61268285+Tonidotpy@users.noreply.github.com>
Copy link
Copy Markdown
Contributor

@Bridiro Bridiro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's good to go for me

@Tonidotpy Tonidotpy merged commit ab90d88 into dev Mar 18, 2026
4 checks passed
@Tonidotpy Tonidotpy deleted the refactor/coding-style branch March 18, 2026 15:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Apply coding styles to ring buffer library

3 participants