SAP / abap-cleaner

ABAP cleaner applies 95+ cleanup rules to ABAP code at a single keystroke
Apache License 2.0
435 stars 48 forks source link

Contribution guideline for newcomers #30

Open ConjuringCoffee opened 1 year ago

ConjuringCoffee commented 1 year ago

I'd like to be able to contribute to this project, but I don't really know how to get started. Would it be possible to provide some kind of architecture overview? I'd also love to see some recommendations on setting up the development environment and on how the changes are to be tested.

jmgrassau commented 1 year ago

Hi ConjuringCoffee,

I'd like to be able to contribute to this project

That's great, happy to hear that!

Would it be possible to provide some kind of architecture overview?

Actually, that's already in the pipeline. There has already been such documentation during the Inner Source phase of the project, containing information on the object model of ABAP cleaner, how to create a new cleanup rule, how to write tests etc. This would hardly need to be reworked, apart from …

some recommendations on setting up the development environment

… so those might take a little longer.

Kind regards, Jörg-Michael