CONTRIBUTING.md

Welcome

Table of Contents

• Code of Conduct
• I don't want to read the whole thing, I just have a question!
• What should I know before I get started?
• How can I contribute?
• Style Guides
• Additional Notes
  • Issue and Pull Request Labels

Code of Conduct

This project's code of conduct can be found here.

Where can I ask for help?

• Add an item to the project's discussion.
• Email us: [email protected]
• Reach out on Twitter: @compressed
• There's a #compressed channel within the Learn Build Teach Discord Server

About this Project

How to request an "enhancement"

Who is involved?

What should I know before I get started?

Short Links to Important Resources

Docs

• Docs
  • Quick Start
• Bugs are tracked through GitHub Issues, with the label "bug"
• Maintainer Email: [email protected]

Testing

As of right now, this project isn't running any tests 😱. However, I'll be adding Cypress tests ASAP and will update the documentation, here accordingly.

Environment Details

To get this project up and running, please review the project's README.md file.

How can I contribute?

How to Submit Changes

How to report a bug

Templates

First bugs for Contributors

Style Guide / Coding conventions

Within the nextjs folder, we're using eslint to help maintain a consistent coding style.

Recognition model