Skip to content

Latest commit

 

History

History
119 lines (95 loc) · 4.38 KB

CONTRIBUTING.md

File metadata and controls

119 lines (95 loc) · 4.38 KB
Raw

Contribution Guide

Thanks for jumping in to contribute at getjustd.com—we’re thrilled to have you on board!

Quick ask: take a moment to review this doc before submitting your first pull request. Also, check out the open issues and pull requests to avoid doubling up on any efforts.

Getting Started

  1. Fork the repository.
  2. Clone the forked repository.
  3. Create a file .env and make sure it has the following content: NEXT_PUBLIC_APP_V1_URL=https://1x.getjustd.com
  4. Install the dependencies with bun run first-time.
  5. Create a new branch: git checkout -b my-branch-name.
  6. Make your changes.
  7. Commit your changes: git commit -m 'Add some feature'.
  8. Push to the branch: git push origin my-branch-name.
  9. Submit a pull request.

Code of Conduct

This project and everyone participating in it is governed by the Justd Code of Conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to team@justd.com.

How to Contribute

Reporting Bugs

Before creating bug reports, please check the existing issues as you might find out that you don't need to create one. When you are creating a bug report, please include as many details as possible.

Suggesting Enhancements

Enhancement suggestions are tracked as GitHub issues. When you are creating an enhancement suggestion, please include as many details as possible.

Pull Requests

Please follow these guidelines when submitting pull requests:

  1. Fork the repository and create your branch from main.
  2. Run bun run lint to check your code for linting errors.
  3. If you've added code that should be tested, add tests.
  4. Format your code with bun run format.
  5. Ensure everything is working as expected by running bun run b which will build the registry and generate the sidebar.
  6. Make sure your code lints.
  7. Make sure your commit messages are clear.

Folder Structure

The folder structure is as follows:

Components

The components folder is the core of this project, it contains ui, docs and blocks folders.

components
├── blocks
├── code
├── docs
│   ├── anatomies
│   ├── buttons ...
│   ├── charts ...
│   ├── collections ...
│   ├── colors ...
│   ├── controls ...
│   ├── date-and-time ...
│   ├── drag-and-drop ...
│   ├── forms ...
│   ├── media ...
│   ├── navigation ...
│   ├── outside ...
│   ├── overlays ...
│   ├── pickers ...
│   ├── statuses ...
│   └── surfaces ...
├── experimental
└── ui

The core ui is inside components/ui, and the demo you see on the docs is inside components/docs.

Registry

The registry is a file that contains all the components and their files. It is used to generate the demo, ui, blocks and anatomies on the docs.

public/registry
├── anatomies
├── blocks
│   ├── navbar ...
│   └── sidebar ...
├── demo
│   ├── buttons ...
│   ├── charts ...
│   ├── collections ...
│   ├── colors ...
│   ├── controls ...
│   ├── date-and-time ...
│   ├── drag-and-drop
│   ├── forms ...
│   ├── media
│   ├── navigation ...
│   ├── outside
│   ├── overlays ...
│   ├── pickers ...
│   ├── statuses ...
│   └── surfaces ...
├── docs
│   └── installation
└── ui

All of this is generated by the resources/scripts/build-registry.ts script by running bun run b.

Code of Conduct

The Justd code of conduct is inspired by the Laravel and Ruby code of conduct. Any violations of this code may be reported to Irsyad (irsyad@parsinta.com):

  • Participants will respect and be tolerant of differing views and opinions.
  • Participants must ensure that their language and actions remain professional and free of personal attacks or disparaging remarks.
  • When interpreting the words and actions of others, participants should always assume good intentions.
  • Behavior that can reasonably be considered harassment or discrimination will not be tolerated.

License

By contributing to Justd, you agree that your contributions will be licensed under its MIT license.