Add document on backend code organization #6853
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Nice work @sheridancbio! This is really useful. One minor thing is the flow of how one would get here from the README.md . There is a link to the documentation already but maybe it's good to add a line that the architecture and folder structure are described there with links to the relevant sections? |
inodb
approved these changes
Nov 23, 2019
docs/Code-Organization.md
Outdated
| which define the code components and modules which make up the backend. The pom.xml | ||
| files also list dependencies on external open source libraries, and dependencies between cBioPortal Maven modules. | ||
| They also give instructions for how to build and package code components into a | ||
| deployable format. |
There was a problem hiding this comment.
I like this - very useful for people not familiar with maven projects
n1zea144
reviewed
Nov 25, 2019
n1zea144
approved these changes
Nov 25, 2019
sheridancbio
force-pushed
the
add-code-organization-docs
branch
2 times, most recently
from
9147a44
to
2203efe
Compare
- general page describing existing maven modules - figure showing modules and dependencies - add links in README.md
sheridancbio
force-pushed
the
add-code-organization-docs
branch
from
2203efe
to
9c98a0d
Compare
|
deleting request for review from @averyniceday in order to merge now |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Describe changes proposed in this pull request:
general page describing existing maven modules
figure showing modules and dependencies
The commit log is comprehensible. It follows 7 rules of great commit messages. For most PRs a single commit should suffice, in some cases multiple topical commits can be useful. During review it is ok to see tiny commits (e.g. Fix reviewer comments), but right before the code gets merged to master or rc branch, any such commits should be squashed since they are useless to the other developers. Definitely avoid merge commits, use rebase instead.
Any screenshots or GIFs?
If this is a new visual feature please add a before/after screenshot or gif
here with e.g. GifGrabber.