I’ve got a fairly simple open-source Java project I am starting. This process is new to me, I’m used to writing programs just for myself. What are some good practices to be aware of when releasing open-source projects in Java?
Here are some things I can think of, can you suggest others?
- version control repository (what do you use to explain relevant tags/branches? an external README file?)
- include appropriate open-source license in code
- include prepackaged executable JAR file, including version number in the filename
- some kind of README file that explains external dependencies needed to build/run the software (is there a common convention for what filename and where to put it?)
- a webpage for the project, w/ a link to it in the source code and/or executable, in case someone obtains the source code or executable first (rather than through the webpage in question)