Skip to content

Latest commit

 

History

History
101 lines (69 loc) · 4.67 KB

CONTRIBUTING.md

File metadata and controls

101 lines (69 loc) · 4.67 KB
Raw

English | 简体中文

Contributing

Thank you for taking your time to contribute and make this project better! Here are some guidelines to help you get started. Please make sure to take a moment and read through them before submitting your contributions.

Code of Conduct

This project is governed by the Contributor Covenant Code of Conduct. By participating, you are expected to adhere to it.

Open Development

All work happens directly on GitHub. Both core team members and external contributors send pull requests which go through the same review process.

Semantic Versioning

This project follows semantic versioning. We release patch versions for bug fixes or other changes that do not change the behavior of the API, minor versions for new features that are backward-compatible, and major versions for any breaking changes.

Every significant change is documented in the changelog file.

Reporting Issues

We use Github issues for bug reports and feature requests. Before reporting an issue, please make sure you have searched for similar issues as they may have been already answered or being fixed. A new issue should be submitted via issue helper. For bug reporting, please include the minimum code that can be used to reproduce the problem. For feature request, please specify what changes you want and what behavior you expect.

Sending a pull request

  1. Fork the repository and create your branch from main. For new feature, please submit your changes directly to the feature branch. Other changes should go against main branch.
  2. Use npm install -g to install basic packages such as lerna and yarn.
  3. Use yarn install to install the dependencies of each package in workspaces (If you encounter a YN0018 error, you can use YARN_CHECKSUM_BEHAVIOR=update yarn to install).
  4. Use npm run init to initialize the project.
  5. Run npm run start to start and preview site.
  6. Make changes to the codebase. Please add tests if applicable.
  7. Make sure the test suite passes with npm run test.
  8. Commit your changes, adhering to the Commit Guidelines
  9. Open a new pull request, referencing corresponding issues if available.

Commit Guidelines

Commit messages are required to follow the conventional-changelog standard:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

Commit types

The following is a list of commit types:

  • feat: A new feature or functionality
  • fix: A bug fix
  • docs: Documentation only changes
  • style: Code formatting or component style changes
  • refactor: Code changes that neither fixes a bug nor adds a feature.
  • perf: Improve performance.
  • test: Add missing or correct existing tests.
  • chore: Other commits that don’t modify src or test files.

Arco-Vue Repository Structure

This repository is managed by lerna and includes the following packages:

  1. web-vue: UI component library
  2. vue-site: Component documentation site
  3. arco-vue-scripts: Component scripts
  4. arco-vue-md-loader: Webpack loader for markdown parsing
  5. arco-vue-site-nav: Navigation bar of documentation site (using React materials)

Web-Vue Component Directory

components/componentName

├── README.zh-CN.md (Note：Don't edit this file, it's generated by script)
├── README.en-US.md (Note：Don't edit this file, it's generated by script)
├── TEMPLATE.md （Template used to generate README file）
├── __test__
│   ├── __snapshots__
│   │   └── demo.test.js.snap （Snapshot）
│   ├── demo.test.ts (Snapshot test)
│   └── index.test.ts （Unit test）
├── __demo__ （Demos for each component）
│   ├── basic.md
│   └── advanced.md
├── index.tsx（Component export）
└── style
    └── index.less（Component style）
    └── index.ts (Component style entry)

Please note that if you make changes that will affect README (e.g. API changes), make sure to run npm run docgen to update README of the component.

For scripts related to the component library, please run under the web-vue directory.

License

By contributing your code to the repository, you agree to license your contribution under the MIT license.