The comments should use the JavaDoc conventions. Code CommentsĪs a matter of policy, all new methods, classes, andįields should include comments explaining what they are for and any other pertinent information. Many other expressions exist to close issues via commit messages. If you simply mention #123 in your message, your message will be appended to the issue but it will remain open. GitHub will automatically update issues when commits are merged in: if your commit message includes the textįixes #123, it will automatically append your message as a comment on the isse and close it. Ideally even prior to your development work since this provides a place to carry out implementation discussions (in the comments). You should create a new ticket prior to checking in, or If no ticket exists for the feature or bug your code implements or fixes, Issues and commitsĪll commits should reference a specific issue number (this was formally decided in issue #175).įor example, Simplify module X configuration #9999. Merges will not occur into master from dev-2.x until that branch is sufficiently advanced and receives approval from the OTP project leadership committee. The dev-2.x branch is managed similarly to dev-1.x but because it's rapidly changing experimental code worked on by relatively few people, we require only one pull request approval from a different organization than the author. We also have validation rules ensuring that the code compiles and all tests pass before pull requests can be merged. We require two pull request approvals from OTP leadership committee members or designated code reviewers from two different organizations. These pull requests are subject to code review. ![]() In turn, all changes to dev-1.x should result from a fast-forward merge of a Github pull request for a single feature, fix, or other change. All other changes to master should result from fast-forward merges of a Github pull request from the dev-1.x branch. Only release commits setting the Maven artifact version to a non-snapshot number should be pushed to the master branch of OTP. All development will occur on the dev-1.x and dev-2.x branches. If you're not yet a committer, please provide patches as pull requests citing the relevant issue.Įven when you do have push access to the repository, pull requests are a good way to get feedback on changes.Īs of January 2019, we have begun work on OTP 2.x and are using a Git branching model derived from Gitflow. OpenTripPlanner is a community based open source project, and we welcome all who wish to contribute.įix typos and improve the documentation on the wiki or within the /docs directory of the project (details below). Will go in a different field with a name like "program arguments". Parameter ( -Xmx2G, or whatever limit you want to place on JVM memory usage). In the field for the VM options you'll want to put your maximum memory You are running are specified separately. Unlike on the command line, the arguments to the JVM and to the main class You want to create a configuration for a Java Application, specifying the main class When you run a JAR from the command line, the JVM automatically knows which classĬontains the entry point into the program (the main function), but in IDEs you must create a "run configuration".īoth IntelliJ and Eclipse have "run" menus, from which you can select an option to edit the run configurations. When running your local copy of the OTP source within an IDE, all command line switches and configuration options willīe identical to the ones used when running the OTP JAR from the command line (as described in theīasic introduction and configuration reference). It involves downloading a lot of JAR files. The IDE should then take care of fetching all the libraries OTP depends on,īased on the Maven project description (POM file) in the base of the OTP repository. ![]() Repository into my IDE as a Maven project. Repository manually (on the command line or using some other Git interface tool), then import the resulting local OTP ![]() Rather than using the version control support in my IDE, I usually find it more straightforward to clone the OTP GitHub That is completely sufficient for working on OTP. IntelliJ IDEA is a commercial product, but there is an open source "community edition" ![]() It is an excellent IDE, and in my experience is quickerĪnd more stable than the competition. Many of the Core OTP developers use IntelliJ IDEA. Git integration is a plus since OTP is under Git version control. All three of these environments are good for working on OTP,Īnd any IDE with Maven build support should also work (ensure that you have the Maven plugins installed and enabled). Java development are Eclipse, IntelliJ IDEA, and Most people writing or modifying OTP code use an Integrated Development Environment (IDE). Developers Guide Working on OTP in an IDE
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |