Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #189

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.md #189

wants to merge 1 commit into from

Conversation

alexkarezin
Copy link

Description of what I changed

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/googlefhirgateway/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project.

In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.

E2E test

TESTED: Documentation-only change

Checklist: I completed these to help reviewers :)

  • I have read and will follow the review process.
  • I am familiar with Google Style Guides for the language I have coded in.
  • My IDE is configured to follow the Google code styles.
  • I ran mvn clean package right before creating this pull request and added all formatting changes to my commit.
  • All new and existing tests passed.
  • My pull request is based on the latest changes of the master branch.

Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/googlefhirgateway/). Built directly from source and updated on schedule. Intended to simplify developer's introduction to the project.

In the spirit of transparency - I am the author of the diagrams. Hope contributors find it useful.
@google-cla
Copy link

google-cla bot commented Sep 19, 2023

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

@alexkarezin
Copy link
Author

@bashir2 Bashir, do you by chance have time to take a quick look and approve? I would much appreciate it!

@bashir2
Copy link
Collaborator

bashir2 commented Oct 3, 2023

@bashir2 Bashir, do you by chance have time to take a quick look and approve? I would much appreciate it!

Thanks for creating this nice tool and applying it to our project. I need to look into more details and also discuss it with other contributors. Some basic questions for now: Is the SourceSpy tool open source? Also what is the schedule on which these diagrams are being updated? Do we have any control on that?

@alexkarezin
Copy link
Author

@bashir2 Bashir, thank you so much for taking a look!

The diagrams produced by the tool can be licensed under the same terms as the project (I assume Apache2). I can denote it on every page if you consider it a better practice. The code analysis engine itself is not open source (same way as many other popular systems on GH like CodeCov, TravisCI etc).

A complete diagram refresh is activated automatically on schedule (weekly), but it will soon be triggered directly by the repository commits and happen with 10 min after the changes are detected.

Let me know if you have any other questions. Thank you for taking into consideration!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants