Bug 345302 - Add a HACKING file explaining or linking basic information on versioning
Summary: Add a HACKING file explaining or linking basic information on versioning
Status: RESOLVED INTENTIONAL
Alias: None
Product: okular
Classification: Applications
Component: general (show other bugs)
Version: unspecified
Platform: Compiled Sources Linux
: NOR normal
Target Milestone: ---
Assignee: Okular developers
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2015-03-18 11:15 UTC by krichter
Modified: 2015-03-21 22:59 UTC (History)
2 users (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:

Attachments
Add an attachment

Note You need to log in before you can comment on or make changes to this bug.
Description krichter 2015-03-18 11:15:44 UTC 
`okular` has its own version and "a version that goes into a particular KDE Applications release"<ref>https://bugs.kde.org/show_bug.cgi?id=345300#c2</ref>. That's confusing and counter-inutitive and should be explained in a `HACKING` file.

Reproducible: Always
Comment 1 Albert Astals Cid 2015-03-18 23:31:02 UTC 
Why do you need that information to code on okular?
Comment 2 krichter 2015-03-18 23:36:22 UTC 
It'd be nice to have. You can put the explanation in `README` or `CONTRIBUTING` as well (it's important to understand in order to not get confused by the bugzilla versioning (see referenced issue above)). It's not necessary.
Comment 3 Albert Astals Cid 2015-03-19 23:42:02 UTC 
Well, i don't know what you would want there or what i woudl put there, can you make a suggestion?
Comment 4 krichter 2015-03-20 14:33:13 UTC 
"The git versioning tags refer to the one of the KDE development platform. In case you want to file bug at https://bugs.kde.org you have to refer to the ?? version which you can find ??. This is explained at ??"
Comment 5 Luigi Toscano 2015-03-20 14:43:05 UTC 
(In reply to krichter722 from comment #4)
> "The git versioning tags refer to the one of the KDE development platform.
> In case you want to file bug at https://bugs.kde.org you have to refer to
> the ?? version which you can find ??. This is explained at ??"

The version for the application is the easiest information to spot: as any application, from the menu:
Help->About Okular

or from the command line, okular --version
Comment 6 krichter 2015-03-20 14:44:10 UTC 
OK. And how'd I find that in the source tree?
Comment 7 Luigi Toscano 2015-03-20 14:58:16 UTC 
core/version.h. 
With "version" in the file name, I would say it's easy to spot.
Also, you can notice that there is an aboutdata.h in the source root, and it includes that file.
Comment 8 krichter 2015-03-20 15:17:28 UTC 
> With "version" in the file name, I would say it's easy to spot. Also, you can notice that there is an aboutdata.h in the source root, and it includes that file.
I guess, one could. My point is that one doesn't have to, which would lower the entry boundary for contributors who aren't too familiar with the KDE version scheme and maybe want to contribute non-programming content only... It's your project. You set/keep those boundaries.
Comment 9 Luigi Toscano 2015-03-20 15:26:27 UTC 
I think asking for the version number was not a problem so far. It is still possible to file a bug in any case (like this one). Of course, the bug report is about an issue and the developers can't reproduce it, the version will be requested. And if you check the past bugs, if the version was not specified, when it's explicitly requested it's usually provided.
Comment 10 Albert Astals Cid 2015-03-21 22:59:50 UTC 
I have not been convinced it is really needed. If you feel otherwise please drop by IRC some time and lets have a realtime conversation about this.

#okular on irc.freenode.net