[keycloak-dev] Fwd: Concept structure in the VCS?

[Stian Thorgersen]

----- Original Message -----
> From: "Lennart Jörelid" <lennart.jorelid at gmail.com>
> To: "Stian Thorgersen" <stian at redhat.com>
> Cc: keycloak-dev at lists.jboss.org
> Sent: Monday, 10 August, 2015 11:57:34 AM
> Subject: Re: [keycloak-dev] Fwd: Concept structure in the VCS?
> 
> Hello there,
> 
> 2015-08-10 10:04 GMT+02:00 Stian Thorgersen <stian at redhat.com>:
> 
> >
> > The code base is already centered as modules, but we'll probably change
> > things somewhat to make public api/spis stand out more. We won't document
> > or add Javadoc to any parts of the code base that aren't public api/spis.
> >
> 
> I believe that some implementation details which carry over into the
> model/configuration domain (i.e. semantics of configuration or
> implementation details) should likely be documented for clarity - even if
> they are not part of APIs or SPIs. However, I can appreciate that these
> types of changes or documentation have less priority than other tasks. We
> all work in some kind of sprint context where priorities have to be made.

-1000 Implementation is documented in the form of code. JavaDoc and other types of documenting implementations are never maintained.

> 
> :)
> 
> > ... and while digging into the codebase, I found some things that I wanted
> > > to share and possibly contribute, partly because I found it somewhat
> > > difficult to understand how the configuration related to the file system.
> > > Also, some best practises were not touched upon in documentation or
> > > examples - and while that is understandable considering that KeyCloak is
> > a
> > > project, I figured I could perhaps submit a suggestion [in the form of a
> > > GitHub pull request] for simplifying somewhat.
> >
> > Sure - I'd welcome improvements, but please write an email top
> > keycloak-dev mailing list outlining each improvement before working on a
> > PR. Refactoring of the code should be done with great consideration as it
> > makes life hard for existing developers and contributors when things
> > change.
> >
> 
> I agree; it is important that changes constitute improvements overall.
> 
> I'll ponder, create a JIRA issue and do the changes in my private KeyCloak
> fork - it can be discussed and dissected there rather than in the KeyCloak
> standard repository.

Please discuss proposed changes on developer mailing list first.

> 
> --
> 
> --
> +==============================+
> | Bästa hälsningar,
> | [sw. "Best regards"]
> |
> | Lennart Jörelid
> | EAI Architect & Integrator
> |
> | jGuru Europe AB
> | Mölnlycke - Kista
> |
> | Email: lj at jguru.se
> | URL:   www.jguru.se
> | Phone
> | (skype):    jgurueurope
> | (intl):     +46 708 507 603
> | (domestic): 0708 - 507 603
> +==============================+
>