Skip to content

Latest commit

 

History

History
31 lines (17 loc) · 1.97 KB

CONTRIBUTING.md

File metadata and controls

31 lines (17 loc) · 1.97 KB

Contributing to TableCheck

👍🎉 First off, thanks for taking the time to contribute! 🎉👍

The following is a set of guidelines for contributing to TableCheck open source packages, which are hosted in the TableCheck Organization on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.

Code of Conduct

This project and everyone participating in it is governed by the TableCheck Code of Conduct. By participating, you are expected to uphold this code.

I don't want to read this whole thing I just have a question!!!

We use GitHub discussions for questions, head over there and ask away! If you're unsure if you have a question or a bug, start with a discussion.

What should I know before I get started?

This repository is primarily for supporting the code conventions and setups that we use internally at TableCheck Inc. We are happy to accept bug reports and bug fixes but any feature requests/enhancements will need to be discussed by our internal Frontend team. This may take some time so please be patient 🙇

How can I contribute?

Helpful contributions are fixing and reporting bugs or suggesting improvements. When reporting a bug please ensure that you include as much information as possible and if possible include a repository to replicate the bug in.

Code styling

Our code style is entirely handled by prettier and eslint. Make sure that the linter and tests pass before submitting a Pull Requests. If they don't pass, we won't fix them or merge the pull request.

Releasing

Our releases are automatic thanks to Auto!! Once a Pull Request is merged, the CI will automatically release a new version. Make sure not to merge pull requests in succession too quickly!