Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Developer Changelog and documenting changes in the Matomo Platform #8127

Closed
mattab opened this issue Jun 17, 2015 · 1 comment · Fixed by matomo-org/developer-documentation#453
Assignees
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base.

Comments

@mattab
Copy link
Member

mattab commented Jun 17, 2015

The goal of this issue is to list all the changes that we aim to document in our Developer Changelog (/CHANGELOG.md). We need to move this knowledge to a guide in developer.piwik.org so that it's shared across team members, and clear to the developer community.

Context

Where we are today:

What to write in developer changelog

As a Piwik product team engineer, we keep the developer changelog up to date by noting any:

  • change to a Reporting API method (eg. new API method added, deprecated, removed)
  • change to Reporting API output (eg. a new field in an API response)
  • change to Reporting API parameter (eg. parameter added, deprecated, removed)
  • change to Tracking API parameter (eg. parameter added, deprecated, removed)
  • change to Piwik JavaScript Tracker feature (eg. new feature, or removed feature)
  • since PHP 8 argument names of public API's are also considered API
  • new console command
  • new parameter for a console command
  • new developer guide
  • update to a third party library
  • any other relevant internal change that may interest developers

Developer changelog structure

These changes are organised in the developer changelog in the following categories:

  • Breaking Changes
  • Deprecations
  • New features
  • New APIs
  • New commands
  • New guides
  • Library updates
  • Internal change

(you will find the template at the bottom of CHANGELOG.md file)

@mattab mattab added the RFC Indicates the issue is a request for comments where the author is looking for feedback. label Jun 17, 2015
@mattab mattab added this to the 3.0.0 milestone Jul 15, 2015
@mattab mattab self-assigned this Aug 13, 2015
@mattab mattab modified the milestones: 3.0.0, 2.16.x Feb 8, 2016
@mattab mattab added the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Apr 1, 2016
@mattab mattab modified the milestones: 3.0.0, 2.16.x (LTS) Apr 1, 2016
@mattab mattab removed the Major Indicates the severity or impact or benefit of an issue is much higher than normal but not critical. label Oct 21, 2019
@tsteur
Copy link
Member

tsteur commented Mar 17, 2021

this is now documented in https://developer.matomo.org/guides/apis

@sgiehl sgiehl added c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base. and removed RFC Indicates the issue is a request for comments where the author is looking for feedback. labels Apr 28, 2021
@mattab mattab changed the title Developer Changelog and documenting changes in the Piwik Platform Developer Changelog and documenting changes in the Matomo Platform May 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: Documentation For issues related to in-app product help messages, or to the Matomo knowledge base.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants