-
Notifications
You must be signed in to change notification settings - Fork 101
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
docs: add diagrams link to README.md #1460
base: master
Are you sure you want to change the base?
Conversation
Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/mobilitydatagtfsvalidator/). 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.
Thanks for opening this pull request! You're awesome. We use semantic commit messages to streamline the release process. Before your pull request can be merged, you should update your pull request title to start with a semantic prefix. Examples of titles with semantic prefixes:
|
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
David, I feel a little bit lost here... I don't believe I caused the said job failure. Can the job be restarted? A little help please. Thanks!!! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi @alexkarezin, I was looking closely at sourcespy
and I think that your contribution is a better fit for the ARCHITECTURE.md documentation rather than in README. We have reserved the README.md badges for critical statutes that affect the project. That's why I think it is preferable to have the diagrams aside from the architecture documentation as a support instead of the main source of documentation.
Summary:
Adding a link to the high-level diagrams including module, library dependency and others (https://sourcespy.com/github/mobilitydatagtfsvalidator/). 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.
Expected behavior:
No behavior changes
gradle test
to make sure you didn't break anything