Skip to content

Latest commit

 

History

History
55 lines (33 loc) · 1.1 KB

CONTRIBUTING.md

File metadata and controls

55 lines (33 loc) · 1.1 KB
Raw

Contributing

If you intend to make major changes you should let others know by creating a new issue.

Fork

Fork this project on GitHub and clone your repository.

git clone https://github.com/username/libspng.git
cd libspng
git remote add upstream https://github.com/randy408/libspng.git

Create a debug build

meson -Ddev_build=true --buildtype=debug build
cd build

Enable ASan/UBSan

meson configure -Db_sanitize=address,undefined

Code

  • Coding style should be consistent with the existing style.

  • Use C99 standard code.

  • Code must be free of undefined behavior

  • Code must conform to the rules of the CERT C Coding Standard.

Test

Start with running Clang Static Analyzer

ninja scan-build

Run the testuite

ninja test

All tests should pass, some runtime errors reported by ASan/UBSan do not fail a test but are considered bugs, check build/meson-logs/testlog.txt for any errors.

Push

Create a merge request once you've pushed your local commits.