简体中文|English
🎉 Welcome to contribute code to L7! 🎉
git clone https://github.com/antvis/L7 --depth=1
Since pnpm workspace is used, pnpm needs to be installed first
pnpm install
# Run DEMO
pnpm dev
Other commands:
pnpm site:dev
Run local websitepnpm test:unit
Run unit testspnpm test-cover
Run unit tests and view code coverage:pnpm test:integration
Run integration testspnpm build
build source code pakages, output to umd, es and lib directoryYou are encouraged to use angular commit-message-format to write commit message. In this way, we could have a more trackable history and an automatically generated changelog.
Commit type must be one of the following:
Use succinct words to describe what did you do in the commit change. Look at these files for more details.
we use changesets for fully automated semantic releases. It can automatically create GitHub Releases and automatically associate the release to the corresponding issue. When we complete development, execute changeset and submit the changeset.
pnpm run changeset
git add .
git commit -m "chore: commit changeset"
If you are developer of AntV repo and you are willing to contribute, feel free to create a new branch, finish your modification and submit a PR. AntV group will review your work and merge it to master branch.
# Create a new branch for development. The name of branch should be semantic, avoiding words like 'update' or 'tmp'. We suggest to use feature/xxx, if the modification is about to implement a new feature.
$ git checkout -b branch-name
# Push your work back to us. Notice that the commit message should be written in the following format.
$ git add . # git add -u to delete files
$ git commit -m "fix: role.use must xxx"
$ git push origin branch-name
Then you can create a Pull Request at L7.
No one can guarantee how much will be remembered about certain PR after some time. To make sure we can easily recap what happened previously, please provide the following information in your PR.
Go to GitHub Action to trigger Create bump version PR Action execution, select the release branch, and trigger Action execution
Wait for the Action to be executed. When the execution is completed, a PR of the changed version will be raised.
Confirm the PR version changes. If there is no problem, approve the PR and wait for the release version Action to be executed. During this period, it will be published to NPM, tagged to GitHub, and GitHub Release will be created.
If step 3 is successful, DingTalk will be notified, the robot will automatically merge the PR, and the new official website will be automatically deployed in the background.
If step 3 fails, a DingTalk message will be notified. Go to GtiHub Action to check the reason for the failure.
release
branchpnpm run changeset
script to create a change set for this version release, and execute the coomit change setpnpm run version-packages
script, update the version number and Changelog of the package to be released, confirm the content and coomitpnpm run publish-packages
script, which will publish the package to NPM and tag it to GitHubrelease
branch to the release branch by submitting a PRTaking the pre-release beta as an example, a new function is added to release the beta version:
beta
branchpnpm exec changeset pre enter beta
command🔗 to enter beta
pre hair modebeta
branchAfter the beta version release verification is completed, it is merged into the main branch release process:
pnpm exec changeset pre exit
Command🔗 to exit pre-release modebeta
branch to the main branch by submitting a PR此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。