Skip to content

contributing.md

Latest commit

 

History

History
111 lines (77 loc) · 3.34 KB

contributing.md

File metadata and controls

111 lines (77 loc) · 3.34 KB
Raw

Contributing

Thanks for your interest in contributing to 8bitcn.com. We're happy to have you here.

Please take a moment to review this document before submitting your first pull request. We also strongly recommend that you check for open issues and pull requests to see if someone else is working on something similar.

If you need any help, feel free to reach out to @orcdev, or to OrcDev Discord Channel.

About this repository

  • We use pnpm for development.

Structure

Path Description
/app The Next.js application for the website.
/components The React components for the website.
/registry.json The registry for the components.

Development

Fork this repo

You can fork this repo by clicking the fork button in the top right corner of this page.

Clone on your local machine

git clone https://github.com/your-username/8bitcn.git

Navigate to project directory

cd 8bitcn

Create a new Branch

git checkout -b my-new-branch

Install dependencies

pnpm i

Examples

  1. To run the 8bitcn.com website:
pnpm dev

Components

We use a registry system for developing components. You can find the source code for the components under app/components/ui/8bit.

app
└── components
    └── ui
        ├── 8bit
            ├── badge
            └── button

When adding or modifying components, please ensure that:

  1. You make the changes for every style.
  2. You update the documentation.
  3. You update the registry.json file with your component's metadata.

Commit Convention

Before you create a Pull Request, please check whether your commits comply with the commit conventions used in this repository.

When you create a commit we kindly ask you to follow the convention category(scope or module): message in your commit message while using one of the following categories:

  • feat / feature: all changes that introduce completely new code or new features

  • fix: changes that fix a bug (ideally you will additionally reference an issue if present)

  • refactor: any code related change that is not a fix nor a feature

  • docs: changing existing or creating new documentation (i.e. README, docs for usage of a lib or cli usage)

  • build: all changes regarding the build of the software, changes to dependencies or the addition of new dependencies

  • test: all changes regarding tests (adding new tests or changing existing ones)

  • ci: all changes regarding the configuration of continuous integration (i.e. github actions, ci system)

  • chore: all changes to the repository that do not fit into any of the above categories

    e.g. feat(components): add new prop to the avatar component

If you are interested in the detailed specification you can visit https://www.conventionalcommits.org/ or check out the Angular Commit Message Guidelines.

Requests for new components

If you have a request for a new component, please open a discussion on GitHub. We'll be happy to help you out.