👍🎉 First off, thanks for taking the time to contribute! 🎉👍
We're thrilled that you'd like to contribute to this project. Your support of this project directly contributes the mission of Optum and UHG to help people live healthier lives and to help make the health system work better for everyone.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. Please review our Contributor License Agreement ("CLA") prior to submitting changes to the project.
💡 The first time you open a pull request in this repository, you will see a comment on your PR with a link that will allow you to sign our Contributor License Agreement (CLA) if necessary.
The process described here has several goals:
- Maintain Knack's quality
- Fix problems that are important to users
- Engage the community in working toward the best possible Knack
- Enable a sustainable system for Knack's maintainers to review contributions
Please follow these steps to have your contribution considered by the maintainers:
- Fork and clone the repository
- Make your change
- Push to your fork and submit a pull request
- Follow all instructions in the template
- Follow the styleguides
- After you submit your pull request, verify that all status checks are passing.
- The first time you open a pull request in this repository, you will see a comment on your PR with a link that will allow you to sign our Contributor License Agreement (CLA) if necessary.
💡 The link will take you to a page that allows you to view our CLA. You will need to click the
Sign in with GitHub to agree buttonand authorize the cla-assistant application to access the email addresses associated with your GitHub account. Agreeing to the CLA is also considered to be an attestation that you either wrote or have the rights to contribute the code. All committers to the PR branch will be required to sign the CLA, but you will only need to sign once. This CLA applies to all repositories in the Optum org.
We make every effort to perform an initial review of all PRs within 1 business day. While the prerequisites above must be satisfied prior to having your pull request approved, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
- Write a good commit message.
Work in Progress pull request are also welcome to get feedback early on, or if there is something blocked you.
- Use the present tense ("Add feature" not "Added feature")
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the first line to 72 characters or less
- Reference issues and pull requests liberally after the first line
- When only changing documentation, include
[ci skip]in the commit title - Consider starting the commit message with an applicable emoji:
- 🎨
:art:when improving the format/structure of the code - 🐎
:racehorse:when improving performance - 🚱
:non-potable_water:when plugging memory leaks - 📝
:memo:when writing docs - 🐧
:penguin:when fixing something on Linux - 🍎
:apple:when fixing something on macOS - 🏁
:checkered_flag:when fixing something on Windows - 🐛
:bug:when fixing a bug - 🔥
:fire:when removing code or files - 💚
:green_heart:when fixing the CI build - ✅
:white_check_mark:when adding tests - 🔒
:lock:when dealing with security - ⬆️
:arrow_up:when upgrading dependencies - ⬇️
:arrow_down:when downgrading dependencies - 👕
:shirt:when removing linter warnings
- 🎨
All JavaScript must adhere to JavaScript Standard Style.