Skip to content

Latest commit

 

History

History
47 lines (27 loc) · 2.53 KB

CONTRIBUTING.md

File metadata and controls

47 lines (27 loc) · 2.53 KB

Contributing to this project

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

The following is a set of guidelines for contributing. 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 all contributors are governed by the Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [email protected].

What should I know before I get started?

Design Decisions

Tech Stack

This project was built in React and I would prefer it to stay in this technology. If you wish to port this to a new tech stack, I would recommend forking this repository and rebuilding it in a separate repository.

Devices

This project was built to be used on larger screened devices, primarily tablet and desktop viewports. Where possible, I have tried to ensure that the CSS is written in a responsive way, however when we get down to mobile viewport sizes, I am happy to leave some visual elements in an unoptimised state.

If you feel that this is an area that you can contribute to, I would love to see what you can come up with.

How Can I Contribute?

Reporting Bugs

Before creating bug reports, please check the current issues against the repository as you might find out that an issue has already been raised. When you are creating a bug report, please include as many details as possible.

Note: If you find a Closed issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.

How Do I Submit A (Good) Bug Report?

Explain the problem and include additional details to help maintainers reproduce the problem:

  • Use a clear and descriptive title for the issue to identify the problem.
  • Describe the exact steps which reproduce the problem in as many details as possible.
  • Describe the behavior you observed after following the steps and point out what exactly is the problem with that behavior.
  • Explain which behavior you expected to see instead and why.
  • Include screenshots and animated GIFs when possible which show you following the described steps and clearly demonstrate the problem.

Include details about your environment:

  • Which browser are you using?
  • What's the name and version of the OS you're using?
  • Which viewport size or device did you encounter the issue on?