CONTRIBUTING.md

Contributing to Drip-form

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

To get started with the repo

Installation

1. Ensure you have Yarn installed.
2. After cloning the repository, run yarn install in the root of the repository.
3. Run yarn build:prod to build project.
4. To start a development server, run yarn start:generator.
5. If you want to monitor changes, run yarn watch:babel.

Code Structure

Currently, the source is split up into a few categories:

• examples: Drip-form examples

  • form-generator

    Drip-form generator example

• packages: Drip-form npm package

  • ajv

    RegisterAJV, imported AJV plugin

  • drip-form

  • drip-form-plugin-formats

    Drip-form AJV formats plugin

  • drip-form-plugin-keywords

    Drip-form AJV keyword plugin

  • drip-form-theme-antd

    Drip-form antd theme

  • generator

    Drip-form generator

  • hooks

    Drip-form hooks

  • utils

    Drip-form utils

• scripts

  sh or node script

• website

  Drip-form website

Semantic versioning

Drip-form follows semantic versioning

Commit message

Drip-form use conventionalcommits to generate CHANGELOG。

See how a minor change to your commit message style can make you a better programmer.

The commit message should be structured as follows:

---

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

<scope> is optional. If your change is specific to one/two packages, consider adding the scope. Scopes should be brief but recognizable, e.g. form, theme, ajv,generator,hooks,utils

The various types of commits:

• feat: a new API or behavior for the end user.
• fix: a bug fix for the end user.
• docs: a change to the website or other Markdown documents in our repo.
• refactor: a change to production code that leads to no behavior difference, e.g. splitting files, renaming internal variables, improving code style...
• test: adding missing tests, refactoring tests; no production code change.
• chore: upgrading dependencies, releasing new versions... Chores that are regularly done for maintenance purposes.
• ...

Also, we use commitizen. You can run yarn cz or npm run cz , you'll be prompted to fill out any required commit fields at commit time.

Do not get too stressed about PR titles, however. The maintainers will help you get them right, and we also have a PR label system that doesn't equate with the commit message types. Your code is more important than conventions!

Code Conventions

We use husky and lint-staged. In pre-commit, automatically run the eslint and prettier to lint code and format code.

Submitting Pull Requests

This project follows GitHub's standard forking model. Please fork the project to submit pull requests.

Contributors

Thanks goes to these wonderful people

People are giving themselves and their free time to contribute to open source projects in so many ways, so we believe everyone should be praised for their contributions (code or not).

Drip-form follows all-contributors specification.

Write a comment on an issue or pull request to recognise their contribution. @all-contributors please add @<username> for <contributions>

For example: @all-contributors please add @mengshang918 for code ✨

For more information, please see all-contributors contributions

Add yourself to the contributor list

Releasing

We use github action and lerna to auto release npm package.

The alpha package is released every Friday at 8 p.m

The latest package is released every Monday at 8 p.m