GithubHelp home page GithubHelp logo

Better document API changes about libkiwix HOT 3 OPEN

kelson42 avatar kelson42 commented on July 22, 2024
Better document API changes

from libkiwix.

Comments (3)

mgautierfr avatar mgautierfr commented on July 22, 2024 1

We should introduce a tool like https://lvc.github.io/abi-compliance-checker/ in our CI to detect a ABI change as soon as possible.

from libkiwix.

kelson42 avatar kelson42 commented on July 22, 2024

@mgautierfr Seems indeed a good security. I have found as well https://github.com/lvc/abi-compliance-checker but seems not maintained.

... But the other point might be the communication, in particular at release time. Could we have an easy and standard way to communicate these changes?

from libkiwix.

mgautierfr avatar mgautierfr commented on July 22, 2024

... But the other point might be the communication, in particular at release time. Could we have an easy and standard way to communicate these changes?

We have, this is semantic versioning we already follow (except when we don't realize ourselves we break the API)

from libkiwix.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.