Developers' Guide Table of Contents
Total Page:16
File Type:pdf, Size:1020Kb
Developers' Guide Table of Contents 1. Developers' Guide . 1 1.1. Other Guides . 1 2. Using an IDE . 2 2.1. Developing using IntelliJ IDEA . 2 2.2. Developing using Eclipse . 38 3. Building Apache Isis . 45 3.1. Git. 45 3.2. Installing Java . 47 3.3. Installing Maven. 48 3.4. Building all of Apache Isis . 49 3.5. Checking for Vulnerabilities . 49 3.6. Checking for use of internal JDK APIs . 49 4. AsciiDoc Documentation . 51 4.1. Where to find the Docs . 51 4.2. Naming Conventions . 51 4.3. Writing the docs . 52 4.4. Build and Review (using Maven) . 52 4.5. Instant Rebuild (using Ruby) . 52 4.6. Publish procedure . 53 5. Contributing . 54 5.1. Recommended Workflow (github) . 54 5.2. Alternative Workflow (JIRA patches) . 55 5.3. Setting up your fork/clone . 56 5.4. Commit messages . 56 5.5. Creating the patch file . 57 5.6. Sample Contribution Workflow . 57 5.7. If your pull request is accepted . 59 6. Appendix: Git Cookbook. 61 6.1. Modifying existing files . 61 6.2. Adding new files . 61 6.3. Deleting files . 61 6.4. Renaming or moving files . 62 6.5. Common Workflows . 62 6.6. Backing up a local branch . 62 6.7. Quick change: stashing changes . 62 6.8. Ignoring files . 63 6.9. More advanced use cases . 63 6.10. If you’ve accidentally worked on master branch . 64 6.11. If you’ve forgotten to prefix your commits (but not pushed) . 64 7. Appendix: Working with Many Repos . 66 7.1. Prerequisites . 66 7.2. _repos.txt . 66 7.3. Bash functions . 67 8. Appendix: Asciidoc Templates . 69 8.1. Callouts . 69 8.2. TODO notes . 69 8.3. Xref to Guides . 69 8.4. Link to Isis Addons. 84 8.5. Source code . 85 8.6. Images . 85 8.7. YouTube (screencasts) . 86 8.8. Tables . ..