search

jQAssistant / Idea-Hub

Hub to propose and discuss new ideas, features, as well as general issues
0 stars 0 forks source link

Developer Guide #3

Closed gavin834 closed 4 years ago

gavin834 commented 8 years ago

It would be useful to provide documentation to assist developers get the jQAssistant code up and running in a working environment.

It might be useful to have two variants of such information - one for people developing the product as part of their own work and another set for those who might want to contribute to the project in future.

The guide should include the minimum versions of tools such as JDK, Maven etc together with discussion of IDE configurations.

Over time, the guide could be expanded to bring in architectural details to assist developers in making the best updates, enhancements & extensions to jQAssistant in a manner in-keeping with the project as a whole.

obfischer commented 8 years ago

Hi Gavin, thanks for your issue. It shows us that we still have to improve our documentation. But we know this since the beginning.

Did you have a look at http://jqassistant.org/get-started/? I think it covers some of your points. Futhermore we will provide a developer guide in some weeks, but I can't promise you a reliable date.

gavin834 commented 8 years ago

Hi Oliver,

I'm raising this issue on the back of the related discussion in the Google group https://groups.google.com/forum/#!topic/jqassistant/QWKwQ42nXvo

I have indeed used the getting started guide, and it did get me started using the tool. Also with the enhancements coming in the manual for the next release, people will have all the information they need to get started using the tool reliably, confident their using the tool in a compatible environment.

This particular issue though relates to providing a developer guide discussing tooling requirements etc. for anyone wanting to build the project from source in an IDE. (Although, with the right version of Maven, the code does of course build straight from GitHub on the command line. No further documentation required there.)

Thanks, Gavin

obfischer commented 8 years ago

I Gavin,

we will cover all this issues in one of the next releases. Thank you for your very helpfull feedback.

DirkMahler commented 8 years ago

See also jQAssistant/jqassistant#242

obfischer commented 4 years ago

Sorry, we see that this is an important topic but currently we don't have the capacity for this.