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.

Sign up for GitHub

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

Jump to bottom

Add FHIR Foundation Project Statement to README #1472

Merged
merged 14 commits into from
Jun 27, 2024
Merged

Add FHIR Foundation Project Statement to README #1472

merged 14 commits into from
Jun 27, 2024

Conversation

KaelynJefferson
Copy link
Collaborator

This PR includes:

  • Updating the README.md with the "FHIR Foundation Project Statement" section that includes information about: Maintainers, Issues/Discussion, License, Contribution Policy, Security Information, and Compliance Information.
  • The sections include links to relevant documents or resources.

KaelynJefferson and others added 9 commits June 13, 2024 13:09
@KaelynJefferson
update readme - missing links
ec3ddd0
@KaelynJefferson
Adding readme relative links for contributing and security docs
3bb08d5
@jafeltra @KaelynJefferson
Remove sushi-config comment with releaseLabel options in init project (…
f95593e 
…#1462)
@KaelynJefferson
Warn when config does not include menu and there is no menu.xml (#1464)
8826538 
* Warn when config does not include menu and there is no menu.xml

* Added requested changes including minimalConfigWithMenu for tests, styling, check variables in menu test
@joepaquette @KaelynJefferson
Issue #1128 - add snapshot option to FshToFhir (#1465)
b9efe0d 
* Issue #1128 - Enable sushiClient (FshToFhir) to create StructureDefinitions with the snapshot data element

* Issue #1128 - add comment about use of snapshot option

* Issue #1128 - update tests
@KaelynJefferson
logical/resource root elements set default to prevent empty/missing d…
91cd168 
…efinition (#1466)

* logical and resource root elements set default to prevent empty or missing definition

* Adding in additional test, shorten if-else statement
@jafeltra @KaelynJefferson
v3.11.0 (#1467)
dfe910d 
* v3.11.0

* New contributor!
@mint-thompson @KaelynJefferson
Add security policy (#1471)
83f2877
@jafeltra @KaelynJefferson
Contribution Policy (#1470)
5ccab5d 
* Add CONTRIBUTING.md and CODE-OF-CONDUCT.md with badge

* Small tweaks

* Use HL7 Code of Conduct
jafeltra
jafeltra reviewed Jun 17, 2024
View reviewed changes
Copy link
Collaborator

@jafeltra jafeltra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks pretty good. I left some very small comments inline.

However, I also noticed that sql-on-fhir-v2 already added their FHIR Foundation Project Statement, and they just used bullet points, rather than the separate headings that we have here. I sort of like the visual simplicity of the bulleted list. It also matches up with the blurb on the FHIR Organization page about the FHIR Foundation Project Statement requirement. What do you think about simplifying to something like that?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
jafeltra
jafeltra reviewed Jun 20, 2024
View reviewed changes
Copy link
Collaborator

@jafeltra jafeltra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for making those updates! I left two more really small comments about the format of the markdown, but all the content looks good to me.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@KaelynJefferson
Copy link
Collaborator Author

Since a reference to the full copy of the LICENSE is included now, do we need to include a License section at the bottom?

@cmoesel
Copy link
Member

cmoesel commented Jun 24, 2024

Since a reference to the full copy of the LICENSE is included now, do we need to include a License section at the bottom?

Let's keep it at the bottom as well. I like it to be prominent and its easy to miss the one sentence in the FHIR Foundation section.

jafeltra
jafeltra approved these changes Jun 24, 2024
View reviewed changes
Copy link
Collaborator

@jafeltra jafeltra left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good to me! Thanks for making those updates!

If we think of it, we can edit the commit message when we merge this to take out the commit messages from commits that are not part of this PR. If we don't think of it, no worries.

cmoesel
cmoesel approved these changes Jun 27, 2024
View reviewed changes
Copy link
Member

@cmoesel cmoesel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect. Thank you, Kaelyn!

@cmoesel cmoesel changed the title Update readme Add FHIR Foundation Project Statement to README Jun 27, 2024
@cmoesel cmoesel merged commit ea80c60 into master Jun 27, 2024
14 checks passed
@cmoesel cmoesel deleted the update-readme branch June 27, 2024 12:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cmoesel cmoesel cmoesel approved these changes

@jafeltra jafeltra jafeltra approved these changes

@mint-thompson mint-thompson Awaiting requested review from mint-thompson

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@KaelynJefferson @cmoesel @jafeltra @joepaquette @mint-thompson