This repository has been archived by the owner on Apr 28, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 167
Development Guide
Sachin Handiekar edited this page Jan 13, 2018
·
5 revisions
To contribute your code, please follow the instructions below -
-
Report any issue/features request in the Github Issues
Use a proper label while reporting any issues/bugs.
-
Fixing the bug
Fix the code according to the following guidelines -
- The code meets the coding convention.
- jUnit test cases are included while submitting a pull request.
- New files contains the @author tag.
-
Send a pull request
Send a pull request to the upstream repository.
-
Merge and close
The issue will be closed once the pull request has been merged and it passes the build in [Travis CI (https://travis-ci.org/sachin-handiekar/jInstagram).
None of these is essential for a pull request, but they will all help.
- Use the Spring Framework code format conventions (import eclipse-code-formatter.xml, if you are using Eclipse).
- Make sure all new .java files to have a simple Javadoc class comment with at least an @author tag identifying you, and preferably at least a paragraph on what the class is for.
- Add yourself as an @author to the .java files that you modify substantially (more than cosmetic changes).
- Add some Javadocs and, if you change the namespace, some XSD doc elements.
- A few unit tests would help a lot as well - someone has to do it.
jInstagram is a maven based project and you can use any IDE to play with it.