Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Proposal to add a repository to host maven-archetype for SpotBugs plugin project #1

Merged
merged 1 commit into from
Feb 26, 2017

Conversation

KengoTODA
Copy link
Member

As @iloveeclipse said in his mail, FindBugs had problem and could not build contributors community.

To build it for SpotBugs, I personally think that it is nice to help developers to develop plugin more active. Because many of core SpotBugs developers are also plugin developers (fb-contrib, find-sec-bug, findbugs-slf4j etc.). Developing original plugin is really useful for developers to make their product stable, and it brings opportunity to read the implementation of SpotBugs too.

Now SpotBugs plugin is not so hard to develop, because it fixed a minor bug which makes product complex, and we also have a module to test with matchers. Then providing project template would help potential contributors to catch up how-to develop plugin, I believe. So I propose to host this project and merge this pull-request to start development as a team.

Note that, of course, documentation is also necessary. Let's improve both of manual and javadoc to get more contribution.
And for now I choose Apache License because I think this is basically nice for Java products, but LGPL v2.1/v3 and GPL v3 are also welcomed if we need to keep consistency with license of SpotBugs itself.

@KengoTODA KengoTODA self-assigned this Feb 25, 2017
@KengoTODA
Copy link
Member Author

one more note: to pass the build, we need to merge spotbugs/spotbugs#140 because JUnit test needs to load SpotBugs plugin in advance.

@jsotuyod
Copy link
Member

This looks amazing! We may want to put the test themselves in a different directory than the one used by the classes to be analyzed in the tests. Maybe a different sourceset?

I personally used a completely different package under src/test/java but never was a huge fan of that solution.

@jsotuyod jsotuyod merged commit f5fc589 into master Feb 26, 2017
@jsotuyod jsotuyod deleted the change-copyright-to-team branch February 26, 2017 17:41
@KengoTODA
Copy link
Member Author

@jsotuyod Please point if I misunderstood what you meant.

Do you mean that it's better to put BadCase.java and GoodCase.java into different package/sourcesets with MyDetectorTest.java?

I prefer putting them into the same package, to group related codes.
But it would be nice to use different source set, to make project clean and well organised.

If we have no understanding mismatch, I will propose another pull request to put BadCase.java and GoodCase.java into new source set such as src/test/cases.

@jsotuyod
Copy link
Member

jsotuyod commented Mar 5, 2017

@KengoTODA that is exactly what I meant. Your proposal sounds amazing. Make sure to add proper config to Gradle Eclipse plugin to add that source folder as part of test code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants