Skip to content

Latest commit

 

History

History
95 lines (65 loc) · 4.32 KB

CONTRIBUTING.md

File metadata and controls

95 lines (65 loc) · 4.32 KB
Raw

English | 日本語

Thanks for your interest in contribute to Yamada Components 😎, you are amazing!!!

When it comes to open source, there are different ways you can contribute, all of which are valuable. Here are some guidelines that should help you as you prepare your contribution.

Setup the Project

The following steps will get you up and running to contribute to Yamada Components:

  1. Fork the repository.

  2. Clone your fork locally.

git clone https://github.com/<your_github_username>/yamada-components.git

cd yamada-components

  1. Setup all the dependencies and packages by running pnpm install. This command will install dependencies.

  2. Run pnpm dev to start the local server.

Development

To improve our development process, we have set up tools and systems.

Tooling

  • Next.js Framework for the website.

Commands

  • pnpm install: Sets up all dependencies and packages.
  • pnpm dev: Launches the local server.
  • pnpm start: Launches the production server.
  • pnpm build: Builds the site.
  • pnpm lint: Checks for code issues.
  • pnpm gen:category-group: Creates a component category group using Plop.
    • Please enter the category group name in kebab-case.
  • pnpm gen:category: Creates a component category using Plop.
    • Please enter the category name in kebab-case.
  • pnpm gen:component: Creates a component from a template using Plop.
    • Please enter the component name in kebab-case.
    • If theme is true, a customized theme will be applied to the component.
    • If config is true, a customized config will be applied to the component.

Making a Pull Request?

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 type(scope or module): message in your commit message while using one of the following types:

  • 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

Tip

If you are interested in the detailed specification you can visit Conventional Commits or check out the Angular Commit Message Guidelines.

Steps to PR

  1. Fork and clone the repository.

  2. Create a new branch out of the main branch. We follow the convention [type/scope]. For example fix/buttons/copy-button or feat/headers. type can be either docs, fix, feat, build, or any other conventional commit type. scope is just a short id that describes the scope of work.

  3. Make changes and commit according to the commit convention.

  4. Once you have completed all of the above tasks, please push your changes. After pushing, a URL for the pull request will be generated. Follow the template and submit your request accordingly. Additionally, check the Checks within the pull request and ensure that the Quality check has successfully completed. If there are any issues, this pull request will not be merged.

License

By contributing code to the Yamada UI GitHub repository, you agree that your contributed code will be licensed under the MIT license.

Thank you for reading till the end. I love you too. 💖