search

koppor / jabref

Collection of simple for JabRef issues. Please submit PRs to https://github.com/jabRef/jabref/.
https://github.com/jabRef/jabref/
MIT License
8 stars 13 forks source link

Integrate SpotBugs #239

Open koppor opened 7 years ago

koppor commented 7 years ago

SpotBugs is an alternative to FindBugs.

5oappy commented 10 months ago

Hi Jabref team,

I have done some work on this issue as it was open and as per your policies I'd like to request an informal pr here first.

I have done the basic integration of spotbugs into the build.gradle as per the documentation.

This has made it so that ./gradlew spotbugsMain executes as well as spotbugsMain now being directly linked to ./gradlew check.

Image

This then outputs a log file in html format which when viewed presents programmed analysis.

Image

However, due to my inexperience with spotbugs overall I am running into spotbugs specific configuration issues that on the surface do not affect the functionality of bug test but do cause the build to fail.

Image

due to this I have not attempted to incorporate any CI/github changes that would lead to a more comprehensive build as I would like to publish a more refined solution.

I understand that this may not be up to standard however I would appreciate going through the review process to further my growth as a developer.

5oappy commented 10 months ago

all changes have been made in: https://github.com/5oappy/jabref/blob/main/build.gradle

koppor commented 10 months ago

However, due to my inexperience with spotbugs overall I am running into spotbugs specific configuration issues that on the surface do not affect the functionality of bug test but do cause the build to fail.

This is why this issue is open. You could go ahead and try to create a minimal working example and report an issue to spotbugs. You could even check out their code and try to reproduce the error locally and then work on a fix.

all changes have been made in: 5oappy/jabref@main/build.gradle

Thank you for sharing. It seems, our documentation can be improved. You are now the second person working on main this week. I changed the link at https://devdocs.jabref.org/getting-into-the-code/guidelines-for-setting-up-a-local-workspace/intellij-13-code-style.html to https://devdocs.jabref.org/contributing#contribute-code. Hopefully, people will read that they need to create a new branch.

5oappy commented 10 months ago

I apologise for my inexperience, I followed the first startup steps and created my own fork so I assumed it would push to my own fork.

Thank you for your feedback. I will try the steps you mentioned.

maybe you can create a new issue for the documentation :)