search

cps-org / cps-config

A drop in replacement for pkg-config/pkgconf using cps files
MIT License
15 stars 7 forks source link

Add a developer guide document #42

Closed dcbaker closed 2 months ago

dcbaker commented 2 months ago

This is still largely a work in progress, but provided as a starting point for further discussion

dcbaker commented 2 months ago

@bretbrownjr, we've had few style/format/etc discussions. I thought it might be easier to open a PR with some initial thoughts and hammer that out than discuss them in feature PRs

bretbrownjr commented 2 months ago

I'd be interested if @lunacd or @tylerjw had thoughts as well, given they're jumping in fresh and recently.

tylerjw commented 2 months ago

You should add a note here on the version of clang-format you are using. I tried locally setting up the automation I like using with the python tool pre-commit, however it reformatted all the source files. This is because versions of clang-format are not compatible with each-other and I suspect you have a different version installed than I do.

We should also add a formatting ci job that verifies the formatting stays as you'd expect in each PR. I can easily contribute this if I know what version of clang-format you are using.

dcbaker commented 2 months ago

I'm using -16 ATM, but I could easily go backwards, or go up to -17 with my distro currently

tylerjw commented 2 months ago

Due to this: https://apt.llvm.org/ it is easy enough for me to get whatever versions I need for each project.

My point was more that it needs to be documented to aid people in contributing to the project.

dcbaker commented 2 months ago

I pulled in all of the suggested changes and squashed those, then rebased this on #49. I can take this off 49 if that's preferable

dcbaker commented 2 months ago

Latest version has the following changes: