GithubHelp home page GithubHelp logo

Proper Changelog about highcharts-react HOT 9 CLOSED

highcharts avatar highcharts commented on August 29, 2024
Proper Changelog

from highcharts-react.

Comments (9)

gvaartjes avatar gvaartjes commented on August 29, 2024 2

@KacperMadej I would prefer the single file, like @orangecoding suggested. If we need (not likely) a similar structure as Highcharts, we can always cut it up later.
Can you make sure a CHANGELOG.md is also added for the Angular and the Vue wrapper?

from highcharts-react.

orangecoding avatar orangecoding commented on August 29, 2024 1

A common thing for open source repos is to either use the github release page as you mention or (and I recommend doing this) maintain a CHANGELOG.md which is a simple markup file. See the example below.

https://github.com/webpack-contrib/less-loader/blob/master/CHANGELOG.md

from highcharts-react.

KacperMadej avatar KacperMadej commented on August 29, 2024 1

@gvaartjes Is there any more preferred format or should/could we add both (CHANGELOG.md and GitHub release list) for React, Angular and Vue wrappers?

from highcharts-react.

orangecoding avatar orangecoding commented on August 29, 2024 1

@TorsteinHonsi it's a bit unusual, but I actually like it. It might however be easier for a small repo like this to maintain the changelog in a single md file.

from highcharts-react.

KacperMadej avatar KacperMadej commented on August 29, 2024

Hi @orangecoding

Logging changes is a good feature for sure.

  1. We could add info in releases list - https://github.com/highcharts/highcharts-react/releases

  2. Where's definition for CHANGELOG.md? Could this be used other than by opening a GitHub page to view the list? @orangecoding

We could do 1, 2 or both, but we need more info to decide.

from highcharts-react.

TorsteinHonsi avatar TorsteinHonsi commented on August 29, 2024

Just a thought - we recently created a structure for changelogs in the main highcharts repo, see https://github.com/highcharts/highcharts/tree/master/changelog/highcharts. It might be an idea to follow the same pattern, but I'll leave it to you guys to decide.

from highcharts-react.

TorsteinHonsi avatar TorsteinHonsi commented on August 29, 2024

Yes, for Highcharts we have other considerations. We primarily use it as the source for generating https://www.highcharts.com/documentation/changelog.

from highcharts-react.

KacperMadej avatar KacperMadej commented on August 29, 2024

@gvaartjes
Done for highcharts-react (https://github.com/highcharts/highcharts-react/blob/master/CHANGELOG.md)
I'll handle highcharts-angular and @Denyllon will handle highcharts-vue on Monday.

from highcharts-react.

gvaartjes avatar gvaartjes commented on August 29, 2024

@KacperMadej thx!

from highcharts-react.

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.