/jiffyscan-frontend

Primary LanguageTypeScriptMIT LicenseMIT

Contributing to Jiffyscan

Welcome to Jiffyscan! We are excited to have you contribute to our open-source project. We welcome all types of contributions, from bug fixes to new features. This document will guide you through the process of contributing to our project. Getting Started

Before you start contributing, make sure you have the latest version of the code from our repository. You can clone our repository using the following command:

bash

git clone https://github.com/jiffy-labs/jiffyscan-frontend.git

and switch to the branch ui-work

git switch ui-work && git pull

Once you have the code, you can install the dependencies by running:

npm install

Getting Started

First, run the development server:

npm run dev
# or
yarn dev
# or
pnpm dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

This project uses next/font to automatically optimize and load Inter, a custom Google Font.

Bug Reports and Feature Requests

If you've found a bug in Jiffyscan, please open a new issue on GitHub. Be sure to include as much detail as possible, including:

  • Steps to reproduce the bug
  • Expected behavior
  • Actual behavior
  • Screenshots or error messages (if applicable)

Pull Requests

If you want to contribute to the project by fixing a bug or adding a new feature, please submit a pull request. Here's how:

  • Fork the repository.
  • Create a new branch from the ui-work branch.
  • Make your changes and commit them.
  • Push your branch to your forked repository.
  • Open a pull request from your branch to the main branch of the original repository.

When submitting a pull request, please include a clear description of your changes and why you made them. Please make sure your code follows our coding standards and is well-documented.

Code of Conduct

We expect all contributors to follow our code of conduct, which can be found in the CODE_OF_CONDUCT.md file in the repository. If you encounter any behavior that violates our code of conduct, please report it to the project maintainers. License

This project is licensed under the MIT license. By contributing to this project, you agree to license your contributions under this license.

Thank you for contributing to Jiffyscan! We appreciate your help in making our project better.