We love your input! We want to make contributing to CareOps as easy and transparent as possible, whether it's:
- Reporting a bug
- Discussing the current state of the code
- Submitting a fix
- Proposing new features
- Becoming a maintainer
We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.
We Use Github Flow
Pull requests are the best way to propose changes to the codebase. We actively welcome your pull requests:
- Fork the repo and create your branch from
main. - If you've added code that should be tested, add tests.
- If you've changed APIs, update the documentation.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue that pull request!
In short, when you submit code changes, your submissions are understood to be under the same Creative Commons Attribution-NonCommercial 4.0 International License that covers the project. Feel free to contact the maintainers if that's a concern.
Report bugs using Github's issue tracker
We use GitHub issues to track public bugs. Report a bug by opening a new issue.
Great Bug Reports tend to have:
- A quick summary and/or background
- Steps to reproduce
- Be specific!
- Give sample code if you can.
- What you expected would happen
- What actually happens
- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
- Use TypeScript for all new code
- 2 spaces for indentation rather than tabs
- Use meaningful variable names
- Write JSDoc comments for functions and complex logic
- Follow the existing code style
By contributing, you agree that your contributions will be licensed under the Creative Commons Attribution-NonCommercial 4.0 International License.
This document was adapted from the open-source contribution guidelines for Facebook's Draft.