Contribution Policy

CODE-OF-CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,99 @@
+# Contributing
+
+We're glad you're thinking about contributing to SUSHI! We welcome all friendly contributions, including:
+
+- bug reports
+- comments and suggestions
+- feature requests
+- bug fixes
+- feature implementations and enhancements
+- documentation updates and additions
+
+To ensure a welcoming environment, we follow the [Contributor Covenant Code of Conduct](CODE-OF-CONDUCT.md) and expect contributors to do the same.
+
+Before making a contribution, please familiarize yourself with this document, as well as our [LICENSE](LICENSE) and [README](README.md).
+
+## Issues
+
+We use GitHub issues to track bug reports, comments, suggestions, questions, and feature requests.
+
+Before submitting a new issue, please check to make sure a similar issue isn't already open. If one is, contribute to that issue thread with your feedback.
+
+When submitting a bug report, please try to provide as much detail as possible. This may include:
+
+- steps to reproduce the problem
+- screenshots demonstrating the problem
+- the full text of error messages
+- relevant outputs
+- any other information you deem relevant
+
+Please note that the GitHub issue tracker is _public_; any issues you submit are immediately visible to everyone. For this reason, do _not_ submit any information that may be considered sensitive.
+
+## Zulip
+
+In addition to GitHub issues, we also use the FHIR Community Chat @ https://chat.fhir.org to discuss the use of FHIR Shorthand and its associated projects. The [#shorthand stream](https://chat.fhir.org/#narrow/stream/215610-shorthand) is used for all FHIR Shorthand questions and discussion.
+
+Before contributing to the discussion on the #shorthand stream, you will need to register for an account. The instructions to sign up can be found when you visit https://chat.fhir.org.
+
+Before starting a new conversation, please check for earlier discussions on a similar issue or topic. If a previous conversation has been started, contribute to that thread with your feedback.
+
+When starting a new topic, please use a descriptive topic and include as much detail as possible.
+
+## Code Contributions
+
+If you are planning to work on a reported bug, suggestion, or feature request, please comment on the relevant issue to indicate your intent to work on it.
+If there is no associated issue, please submit a new issue describing the feature you plan to implement or the bug you plan to fix.
+This reduces the likelihood of duplicated effort and also provides the maintainers an opportunity to ask questions, provide hints, or indicate any concerns _before_ you invest your time.
+
+### Coding Practices
+
+Code that is contributed to this project should be done in a personal fork of this repository and follow the coding practices specified in our Best Practices documentation (coming soon!).
+
+### Before Submitting a Pull Request
+
+Before submitting a Pull Request for a code contribution:
+
+- [Rebase](https://git-scm.com/book/en/v2/Git-Branching-Rebasing) on master or [merge](https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging) master into your branch if your code is out of sync with master
+  - If you need help with this, submit your Pull Request without rebasing and indicate you need help
+- Build the code (if applicable) and ensure there are no new warnings or errors
+- Run the tests with `npm test` and ensure that all tests pass
+- Run the linter with `npm run lint` and ensure that there are no linter warnings or errors
+- Run the Prettier formatter with `npm run prettier` and ensure that there are no formatting warnings or errors
+
+  _Note: `npm run check` will run the `test`, `lint`, and `prettier` scripts at once_
+
+- Ensure any new dependencies do not contain known security vulnerabilities.
+  - We recommend using `npm audit` to ensure there are no new security vulnerabilities introduced on your branch
+
+For details on how to build, test, lint, and format see the individual project README file.
+
+### Submitting a Pull Request
+
+Pull requests should include a summary of the work, as well as any specific guidance regarding how to test or invoke the code.
+
+When project maintainers review the pull request, they will:
+
+- Verify the contribution is compatible with the project's goals and mission
+- Run the project's unit tests, linters, and formatters to ensure there are no violations
+- Deploy the code locally to ensure it works as expected
+- Review all code changes in detail, looking for:
+  - potential bugs, regressions, security issues, or unintended consequences
+  - edge cases that may not be properly handled
+  - application of generally accepted best practices
+  - adequate unit tests and documentation
+
+### If the Pull Request Passes Review
+
+Congratulations! Your code will be merged by a maintainer into the project's master branch!
+
+### If the Pull Request Does Not Pass Review
+
+If the review process uncovers any issues or concerns, a maintainer will communicate them via a Pull Request comment. In most cases, the maintainer will also suggest changes that can be made to address those concerns and eventually have the Pull Request accepted. If this happens:
+
+- address any noted issues or concerns
+- rebase or merge master (if necessary) and push your code again (may require a force push if you rebased)
+- comment on the Pull Request indicating it is ready for another review
+
+## Apache 2.0
+
+All contributions to this project will be released under the [Apache 2.0 license](http://www.apache.org/licenses/LICENSE-2.0). By submitting a pull request, you are agreeing to comply with this license. As indicated by the license, you are also attesting that you are the copyright owner, or an individual or Legal Entity authorized to submit the contribution on behalf of the copyright owner.

README.md

@@ -1,5 +1,6 @@
 ![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/fhir/sushi/ci-workflow.yml?branch=master)
 ![npm](https://img.shields.io/npm/v/fsh-sushi)
+[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](CODE-OF-CONDUCT.md)
 
 # SUSHI