# Contributing to Upup

We love your input! We want to make contributing to Upup 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

## Development Process

1. Fork the repo and create your branch from `master`
2. Install dependencies using `pnpm install` or whatever package manager you use
3. Make your changes
4. Run `pnpm run prettier-check` to ensure code style
5. Run `pnpm run lint` to ensure code quality
6. Run `pnpm run test` to ensure everything works as expected
7. Run `pnpm run build` to ensure everything builds properly
8. Create a pull request!

## Pull Request Process

1. Update the README.md with details of changes if needed
2. The PR will be merged once you have the sign-off of at least one maintainer

## Any contributions you make will be under the MIT Software License

When you submit code changes, your submissions are understood to be under the same [MIT License](LICENSE) that covers the project.

## Report bugs using Github's [issue tracker](https://github.com/DevinoSolutions/upup/issues)

We use GitHub issues to track public bugs.

## Write bug reports with detail, background, and sample code

**Great Bug Reports** tend to have:

-   A quick summary and/or background
-   Steps to reproduce
-   What you expected would happen
-   What actually happens
-   Notes (possibly including why you think this might be happening)

## License

By contributing, you agree that your contributions will be licensed under its MIT License.

## References

This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/master/CONTRIBUTING.md).